From 3707f8e8b375fc755900de5a76651ff617d440a7 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Thu, 11 May 2023 15:38:03 +0200 Subject: [PATCH] chore: regenerated documentation (#10) --- docs/docs/AWSAutoScaling.md | 56 + docs/docs/AWSCloudProviderContainer.md | 181 ++ docs/docs/AWSClustersDNSApi.md | 160 ++ docs/docs/AWSComputeAutoScaling.md | 82 + docs/docs/AWSCustomDNSEnabled.md | 51 + docs/docs/AWSHardwareSpec.md | 134 + docs/docs/AWSInterfaceEndpoint.md | 134 + docs/docs/AWSKMS.md | 212 ++ docs/docs/AWSPeerVpc.md | 265 ++ docs/docs/AWSPeerVpcRequest.md | 260 ++ docs/docs/AWSPrivateLinkConnection.md | 186 ++ docs/docs/AWSProviderSettings.md | 207 ++ docs/docs/AWSRegionConfig.md | 238 ++ docs/docs/AccessListItem.md | 77 + docs/docs/AccessTrackingApi.md | 4 +- docs/docs/AddUserToTeam.md | 51 + docs/docs/Alert.md | 338 +++ docs/docs/AlertAudit.md | 379 +++ docs/docs/AlertAuditType.md | 13 + docs/docs/AlertConfig.md | 264 ++ docs/docs/AlertConfigAudit.md | 379 +++ docs/docs/AlertConfigAuditType.md | 19 + docs/docs/AlertConfigViewForNdsGroup.md | 316 +++ docs/docs/AlertConfigurationsApi.md | 630 +++++ docs/docs/AlertViewForNdsGroup.md | 576 ++++ docs/docs/AlertsApi.md | 333 +++ docs/docs/ApiAtlasPartitionFieldView.md | 72 + docs/docs/ApiInstanceSizeView.md | 82 + docs/docs/ApiRoleAssignmentView.md | 108 + docs/docs/ApiUser.md | 186 ++ docs/docs/ApiUserEventTypeViewForNdsGroup.md | 29 + docs/docs/ApiUserEventTypeViewForOrg.md | 29 + docs/docs/ApiUserEventViewForNdsGroup.md | 353 +++ docs/docs/ApiUserEventViewForOrg.md | 353 +++ docs/docs/AppServiceAlert.md | 359 +++ .../AppServiceAlertConfigViewForNdsGroup.md | 259 ++ docs/docs/AppServiceEvent.md | 197 ++ docs/docs/AppServiceEventType.md | 33 + docs/docs/AppServiceEventTypeViewAlertable.md | 31 + ...erviceEventTypeViewAlertableNoThreshold.md | 29 + ...viceEventTypeViewAlertableWithThreshold.md | 11 + ...ServiceMetricAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/AppServiceMetricMatcher.md | 108 + docs/docs/AppServiceMetricMatcherField.md | 11 + docs/docs/AppServiceMetricThreshold.md | 160 ++ docs/docs/AppUser.md | 333 +++ docs/docs/AtlasSearchApi.md | 415 +++ docs/docs/AuditLog.md | 119 + docs/docs/AuditingApi.md | 160 ++ docs/docs/AutoExportPolicy.md | 82 + docs/docs/AutoScaling.md | 82 + docs/docs/AutoScalingV15.md | 82 + docs/docs/AutomationConfigEvent.md | 353 +++ docs/docs/AutomationConfigEventType.md | 11 + docs/docs/AvailableDeployment.md | 286 ++ docs/docs/AvailableProject.md | 124 + docs/docs/AvailableRegion.md | 82 + docs/docs/AzureAutoScaling.md | 56 + docs/docs/AzureCloudProviderContainer.md | 202 ++ docs/docs/AzureComputeAutoScaling.md | 82 + docs/docs/AzureHardwareSpec.md | 82 + docs/docs/AzureKeyVault.md | 290 +++ docs/docs/AzurePeerNetwork.md | 239 ++ docs/docs/AzurePeerNetworkRequest.md | 234 ++ docs/docs/AzurePrivateEndpoint.md | 186 ++ docs/docs/AzurePrivateLinkConnection.md | 212 ++ docs/docs/AzureProviderSettings.md | 155 ++ docs/docs/AzureRegionConfig.md | 238 ++ docs/docs/BSONTimestamp.md | 82 + docs/docs/BiConnector.md | 82 + ...lingEventTypeViewAlertableWithThreshold.md | 13 + docs/docs/BillingEventTypeViewForNdsGroup.md | 103 + docs/docs/BillingEventTypeViewForOrg.md | 123 + docs/docs/BillingEventViewForNdsGroup.md | 405 +++ docs/docs/BillingEventViewForOrg.md | 405 +++ ...lingThresholdAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/CharFilterhtmlStrip.md | 77 + docs/docs/CharFiltericuNormalize.md | 51 + docs/docs/CharFiltermapping.md | 72 + docs/docs/CharFiltermappingMappings.md | 56 + docs/docs/CharFilterpersian.md | 51 + docs/docs/Checkpoint.md | 264 ++ docs/docs/CheckpointPart.md | 160 ++ docs/docs/CloudBackupsApi.md | 2320 +++++++++++++++++ docs/docs/CloudMigrationServiceApi.md | 619 +++++ docs/docs/CloudProviderAccess.md | 56 + docs/docs/CloudProviderAccessAWSIAMRole.md | 233 ++ docs/docs/CloudProviderAccessApi.md | 397 +++ ...loudProviderAccessAzureServicePrincipal.md | 233 ++ ...CloudProviderAccessDataLakeFeatureUsage.md | 82 + ...viderAccessEncryptionAtRestFeatureUsage.md | 92 + ...roviderAccessExportSnapshotFeatureUsage.md | 82 + docs/docs/CloudProviderAccessFeatureUsage.md | 82 + ...iderAccessFeatureUsageDataLakeFeatureId.md | 82 + ...cessFeatureUsageExportSnapshotFeatureId.md | 82 + docs/docs/CloudProviderAccessRole.md | 363 +++ docs/docs/CloudProviderContainer.md | 327 +++ docs/docs/Cluster.md | 316 +++ docs/docs/ClusterAlert.md | 385 +++ .../docs/ClusterAlertConfigViewForNdsGroup.md | 259 ++ .../ClusterDescriptionConnectionStrings.md | 212 ++ ...riptionConnectionStringsPrivateEndpoint.md | 160 ++ ...onnectionStringsPrivateEndpointEndpoint.md | 108 + docs/docs/ClusterDescriptionProcessArgs.md | 310 +++ docs/docs/ClusterDescriptionV15.md | 576 ++++ docs/docs/ClusterEventTypeViewAlertable.md | 11 + docs/docs/ClusterEventTypeViewForNdsGroup.md | 13 + docs/docs/ClusterEventViewForNdsGroup.md | 223 ++ docs/docs/ClusterMatcher.md | 108 + docs/docs/ClusterMatcherField.md | 11 + docs/docs/ClusterOutageSimulation.md | 186 ++ docs/docs/ClusterOutageSimulationApi.md | 244 ++ .../ClusterOutageSimulationOutageFilter.md | 108 + docs/docs/ClusterProviderSettings.md | 259 ++ docs/docs/ClusterStatus.md | 82 + docs/docs/ClustersApi.md | 716 +++++ docs/docs/Collation.md | 259 ++ docs/docs/ComputeAutoScaling.md | 82 + docs/docs/ComputeAutoScalingV15.md | 134 + docs/docs/ConnectedOrgConfig.md | 197 ++ docs/docs/ContainerPeer.md | 103 + docs/docs/ContainerPeerViewRequest.md | 464 ++++ ...peViewForNdsGroupAlertableWithThreshold.md | 11 + ...ckupThresholdAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/CreateAWSEndpointRequest.md | 56 + docs/docs/CreateAWSEndpointRequestAllOf.md | 56 + docs/docs/CreateApiKey.md | 82 + docs/docs/CreateAzureEndpointRequest.md | 82 + docs/docs/CreateAzureEndpointRequestAllOf.md | 82 + docs/docs/CreateEndpointServiceRequest.md | 72 + docs/docs/CreateGCPEndpointGroupRequest.md | 108 + .../CreateGCPEndpointGroupRequestAllOf.md | 108 + docs/docs/CreateGCPForwardingRuleRequest.md | 82 + docs/docs/CreateOrganizationRequest.md | 103 + docs/docs/CreateOrganizationResponse.md | 108 + .../CreatePeeringConnection200Response.md | 469 ++++ docs/docs/CreatePrivateEndpointRequest.md | 160 ++ docs/docs/Criteria.md | 155 ++ docs/docs/CustomCriteria.md | 77 + docs/docs/CustomDBRole.md | 103 + docs/docs/CustomDatabaseRolesApi.md | 394 +++ docs/docs/CustomZoneMappings.md | 56 + docs/docs/CustomerX509.md | 82 + docs/docs/DBAction.md | 77 + docs/docs/DBResource.md | 93 + docs/docs/DLSIngestionSink.md | 134 + docs/docs/DailySchedule.md | 155 ++ docs/docs/DataExplorerAccessedEvent.md | 431 +++ docs/docs/DataExplorerAccessedEventType.md | 17 + docs/docs/DataFederationApi.md | 1109 ++++++++ docs/docs/DataFederationQueryLimit.md | 202 ++ docs/docs/DataFederationTenantQueryLimit.md | 228 ++ docs/docs/DataLakeAWSCloudProviderConfig.md | 150 ++ docs/docs/DataLakeAtlasStore.md | 155 ++ docs/docs/DataLakeAtlasStoreReadPreference.md | 108 + .../DataLakeAtlasStoreReadPreferenceTag.md | 82 + docs/docs/DataLakeCloudProviderConfig.md | 51 + docs/docs/DataLakeDataProcessRegion.md | 72 + docs/docs/DataLakeDatabase.md | 134 + docs/docs/DataLakeDatabaseCollection.md | 82 + docs/docs/DataLakeDatabaseDataSource.md | 290 +++ docs/docs/DataLakeHTTPStore.md | 155 ++ docs/docs/DataLakeOnlineArchiveStore.md | 140 + docs/docs/DataLakePipelinesApi.md | 1040 ++++++++ docs/docs/DataLakeRegion.md | 27 + docs/docs/DataLakeS3Store.md | 259 ++ docs/docs/DataLakeStorage.md | 82 + docs/docs/DataLakeStore.md | 426 +++ docs/docs/DataLakeTenant.md | 134 + docs/docs/DataLakeView.md | 108 + docs/docs/DataMetricAlert.md | 489 ++++ docs/docs/DataMetricEvent.md | 483 ++++ docs/docs/DataMetricThreshold.md | 160 ++ docs/docs/DataMetricUnits.md | 29 + docs/docs/DataMetricValue.md | 82 + docs/docs/DataProtectionSettings.md | 316 +++ docs/docs/Database.md | 82 + docs/docs/DatabaseUser.md | 327 +++ docs/docs/DatabaseUsersApi.md | 409 +++ docs/docs/Datadog.md | 103 + docs/docs/DatadogNotification.md | 155 ++ docs/docs/DateCriteria.md | 134 + docs/docs/DedicatedHardwareSpec.md | 134 + .../docs/DefaultAlertConfigViewForNdsGroup.md | 259 ++ docs/docs/DefaultAlertViewForNdsGroup.md | 359 +++ docs/docs/DefaultEventViewForNdsGroup.md | 353 +++ docs/docs/DefaultEventViewForOrg.md | 353 +++ docs/docs/DefaultLimit.md | 150 ++ docs/docs/DefaultSchedule.md | 51 + docs/docs/DeleteCopiedBackups.md | 108 + docs/docs/Destination.md | 119 + docs/docs/DiskBackupBaseRestoreMember.md | 56 + docs/docs/DiskBackupCopySetting.md | 160 ++ docs/docs/DiskBackupExportJob.md | 337 +++ docs/docs/DiskBackupExportJobRequest.md | 124 + .../docs/DiskBackupOnDemandSnapshotRequest.md | 108 + docs/docs/DiskBackupReplicaSet.md | 446 ++++ docs/docs/DiskBackupRestoreJob.md | 483 ++++ docs/docs/DiskBackupShardedClusterSnapshot.md | 420 +++ .../DiskBackupShardedClusterSnapshotMember.md | 93 + docs/docs/DiskBackupSnapshot.md | 498 ++++ .../docs/DiskBackupSnapshotAWSExportBucket.md | 160 ++ docs/docs/DiskBackupSnapshotSchedule.md | 394 +++ docs/docs/DiskGBAutoScaling.md | 56 + docs/docs/DiskPartition.md | 82 + docs/docs/EmailNotification.md | 129 + docs/docs/EncryptionAtRest.md | 108 + ...tionAtRestUsingCustomerKeyManagementApi.md | 160 ++ ...EncryptionKeyAlertConfigViewForNdsGroup.md | 285 ++ .../EncryptionKeyEventTypeViewAlertable.md | 15 + docs/docs/Endpoint.md | 290 +++ docs/docs/EndpointService.md | 316 +++ docs/docs/Error.md | 160 ++ docs/docs/EventTypeForNdsGroup.md | 923 +++++++ docs/docs/EventTypeForOrg.md | 393 +++ docs/docs/EventViewForNdsGroup.md | 810 ++++++ docs/docs/EventViewForOrg.md | 550 ++++ docs/docs/EventsApi.md | 348 +++ .../ExampleResourceResponseView20230101.md | 77 + .../ExampleResourceResponseView20230201.md | 129 + docs/docs/ExportStatus.md | 82 + docs/docs/FTSAnalyzers.md | 124 + docs/docs/FTSAnalyzersCharFiltersInner.md | 98 + docs/docs/FTSAnalyzersTokenFiltersInner.md | 396 +++ docs/docs/FTSAnalyzersTokenizer.md | 161 ++ docs/docs/FTSIndex.md | 275 ++ docs/docs/FTSIndexAudit.md | 353 +++ docs/docs/FTSIndexAuditType.md | 21 + docs/docs/FTSMappings.md | 82 + docs/docs/FTSMetric.md | 72 + docs/docs/FTSMetrics.md | 176 ++ docs/docs/FTSSynonymMappingDefinition.md | 93 + docs/docs/FederatedAuthenticationApi.md | 1177 +++++++++ docs/docs/FederatedUser.md | 140 + docs/docs/FieldTransformation.md | 82 + docs/docs/ForNdsGroup.md | 275 ++ docs/docs/FreeAutoScaling.md | 56 + docs/docs/FreeProviderSettings.md | 155 ++ docs/docs/GCPAutoScaling.md | 56 + docs/docs/GCPCloudProviderContainer.md | 207 ++ docs/docs/GCPComputeAutoScaling.md | 82 + docs/docs/GCPConsumerForwardingRule.md | 108 + docs/docs/GCPEndpointGroup.md | 160 ++ docs/docs/GCPEndpointService.md | 186 ++ docs/docs/GCPHardwareSpec.md | 82 + docs/docs/GCPPeerVpc.md | 197 ++ docs/docs/GCPPeerVpcRequest.md | 192 ++ docs/docs/GCPProviderSettings.md | 129 + docs/docs/GCPRegionConfig.md | 238 ++ docs/docs/GeoSharding.md | 82 + docs/docs/GetPeeringConnection200Response.md | 469 ++++ docs/docs/GlobalClustersApi.md | 406 +++ docs/docs/GoogleCloudKMS.md | 134 + docs/docs/GreaterThanDaysThreshold.md | 108 + docs/docs/GreaterThanRawThreshold.md | 108 + ...nRawThresholdAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/GreaterThanTimeThreshold.md | 108 + docs/docs/Group.md | 192 ++ docs/docs/GroupInvitation.md | 264 ++ docs/docs/GroupInvitationRequest.md | 82 + docs/docs/GroupInvitationUpdateRequest.md | 56 + docs/docs/GroupMaintenanceWindow.md | 124 + docs/docs/GroupName.md | 56 + docs/docs/GroupNotification.md | 181 ++ docs/docs/GroupPaginatedEvent.md | 108 + docs/docs/GroupSettings.md | 186 ++ docs/docs/HardwareSpec.md | 134 + docs/docs/HipChatNotification.md | 155 ++ docs/docs/HostAlertConfigViewForNdsGroup.md | 259 ++ docs/docs/HostAlertViewForNdsGroup.md | 437 ++++ docs/docs/HostEventTypeViewForNdsGroup.md | 33 + .../HostEventTypeViewForNdsGroupAlertable.md | 19 + docs/docs/HostEventViewForNdsGroup.md | 431 +++ docs/docs/HostMatcher.md | 108 + docs/docs/HostMatcherField.md | 19 + docs/docs/HostMetricAlert.md | 489 ++++ .../HostMetricAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/HostMetricEvent.md | 483 ++++ docs/docs/HostMetricEventType.md | 13 + docs/docs/HostMetricEventTypeViewAlertable.md | 11 + docs/docs/HostMetricThreshold.md | 160 ++ docs/docs/HostMetricValue.md | 82 + docs/docs/HostViewAtlas.md | 316 +++ docs/docs/IdentityProvider.md | 363 +++ docs/docs/IdentityProviderUpdate.md | 259 ++ docs/docs/IndexOptions.md | 493 ++++ docs/docs/IndexRequest.md | 150 ++ docs/docs/IngestionPipeline.md | 264 ++ docs/docs/IngestionPipelineRun.md | 316 +++ docs/docs/IngestionSink.md | 134 + docs/docs/IngestionSource.md | 186 ++ docs/docs/InheritedRole.md | 72 + docs/docs/InstanceSize.md | 71 + docs/docs/Integration.md | 568 ++++ docs/docs/Invoice.md | 524 ++++ docs/docs/InvoicesApi.md | 318 +++ docs/docs/Key.md | 124 + docs/docs/LDAPConfigurationApi.md | 388 +++ docs/docs/Label.md | 82 + docs/docs/LegacyBackupApi.md | 827 ++++++ docs/docs/LegacyBackupRestoreJobsApi.md | 88 + docs/docs/LegacyClusterDescription.md | 836 ++++++ docs/docs/LegacyReplicationSpec.md | 134 + docs/docs/LessThanDaysThreshold.md | 108 + docs/docs/LessThanTimeThreshold.md | 108 + ...TimeThresholdAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/Limit.md | 202 ++ docs/docs/LineItem.md | 472 ++++ docs/docs/Link.md | 82 + docs/docs/LinkAtlas.md | 82 + .../docs/ListPeeringConnections200Response.md | 108 + docs/docs/LiveMigrationRequest.md | 145 ++ docs/docs/LiveMigrationResponse.md | 170 ++ docs/docs/MaintenanceWindowsApi.md | 377 +++ docs/docs/ManagedNamespace.md | 212 ++ docs/docs/ManagedNamespaces.md | 197 ++ docs/docs/MatcherField.md | 25 + docs/docs/MatcherHostType.md | 21 + docs/docs/Measurement.md | 108 + docs/docs/MeasurementViewAtlas.md | 108 + docs/docs/MeasurementsGeneralViewAtlas.md | 290 +++ docs/docs/MeasurementsIndexes.md | 290 +++ docs/docs/MeasurementsNonIndex.md | 238 ++ docs/docs/MetricDataPoint.md | 82 + docs/docs/MetricDataPointViewAtlas.md | 82 + docs/docs/MicrosoftTeams.md | 77 + docs/docs/MicrosoftTeamsNotification.md | 129 + docs/docs/MongoDBAccessLogs.md | 264 ++ docs/docs/MongoDBAccessLogsList.md | 56 + docs/docs/MongoDBCloudUsersApi.md | 229 ++ docs/docs/MonitoringAndLogsApi.md | 1187 +++++++++ docs/docs/MonthlySchedule.md | 181 ++ docs/docs/MultiCloudClustersApi.md | 478 ++++ docs/docs/NDSAuditTypeViewForNdsGroup.md | 337 +++ docs/docs/NDSAuditTypeViewForOrg.md | 11 + docs/docs/NDSAuditViewForNdsGroup.md | 379 +++ docs/docs/NDSAuditViewForOrg.md | 379 +++ .../NDSAutoScalingAuditTypeViewForNdsGroup.md | 17 + .../NDSAutoScalingAuditViewForNdsGroup.md | 353 +++ docs/docs/NDSLDAP.md | 290 +++ .../NDSLDAPVerifyConnectivityJobRequest.md | 186 ++ ...SLDAPVerifyConnectivityJobRequestParams.md | 192 ++ ...PVerifyConnectivityJobRequestValidation.md | 82 + docs/docs/NDSLabel.md | 82 + docs/docs/NDSNotification.md | 129 + docs/docs/NDSServerlessInstanceAudit.md | 353 +++ docs/docs/NDSServerlessInstanceAuditType.md | 27 + docs/docs/NDSTenantEndpointAudit.md | 405 +++ docs/docs/NDSTenantEndpointAuditType.md | 29 + docs/docs/NDSUserToDNMapping.md | 103 + ...uthenticationAlertConfigViewForNdsGroup.md | 285 ++ ...serAuthenticationEventTypeViewAlertable.md | 15 + docs/docs/NamespaceObj.md | 82 + docs/docs/Namespaces.md | 56 + docs/docs/NetPeerRequestBase.md | 72 + docs/docs/NetworkPeeringApi.md | 1029 ++++++++ docs/docs/NetworkPermissionEntry.md | 212 ++ docs/docs/NetworkPermissionEntryStatus.md | 51 + docs/docs/NewRelic.md | 140 + docs/docs/Notification.md | 727 ++++++ docs/docs/NotificationViewForNdsGroup.md | 701 +++++ docs/docs/NumberMetricAlert.md | 489 ++++ docs/docs/NumberMetricEvent.md | 483 ++++ docs/docs/NumberMetricThreshold.md | 160 ++ docs/docs/NumberMetricUnits.md | 17 + docs/docs/NumberMetricValue.md | 82 + docs/docs/OnDemandCpsSnapshotSource.md | 160 ++ docs/docs/OnlineArchive.md | 290 +++ docs/docs/OnlineArchiveApi.md | 499 ++++ docs/docs/OnlineArchiveSchedule.md | 207 ++ docs/docs/Operator.md | 13 + docs/docs/OpsGenie.md | 103 + docs/docs/OpsGenieNotification.md | 155 ++ docs/docs/OrgEventTypeViewForOrg.md | 97 + docs/docs/OrgEventViewForOrg.md | 379 +++ docs/docs/OrgFederationSettings.md | 160 ++ docs/docs/OrgGroup.md | 212 ++ docs/docs/OrgNotification.md | 181 ++ docs/docs/OrgPaginatedEvent.md | 108 + docs/docs/Organization.md | 129 + docs/docs/OrganizationInvitation.md | 285 ++ docs/docs/OrganizationInvitationRequest.md | 108 + .../OrganizationInvitationUpdateRequest.md | 82 + docs/docs/OrganizationSettings.md | 108 + docs/docs/OrganizationsApi.md | 1162 +++++++++ docs/docs/PagerDuty.md | 103 + docs/docs/PagerDutyNotification.md | 155 ++ docs/docs/PaginatedAWSPeerVpc.md | 108 + docs/docs/PaginatedAlert.md | 108 + docs/docs/PaginatedAlertConfig.md | 108 + docs/docs/PaginatedApiApiUser.md | 108 + docs/docs/PaginatedApiAppUser.md | 108 + docs/docs/PaginatedApiAtlasCheckpoint.md | 108 + docs/docs/PaginatedApiAtlasDatabaseUser.md | 108 + .../PaginatedApiAtlasDiskBackupExportJob.md | 108 + docs/docs/PaginatedApiAtlasProviderRegions.md | 108 + ...natedApiAtlasServerlessBackupRestoreJob.md | 108 + ...ginatedApiAtlasServerlessBackupSnapshot.md | 108 + docs/docs/PaginatedApiInvoice.md | 108 + docs/docs/PaginatedApiUserAccessList.md | 108 + docs/docs/PaginatedAppUser.md | 108 + docs/docs/PaginatedAtlasGroup.md | 108 + docs/docs/PaginatedAzurePeerNetwork.md | 108 + docs/docs/PaginatedBackupSnapshot.md | 108 + .../PaginatedBackupSnapshotExportBucket.md | 108 + docs/docs/PaginatedCloudBackupReplicaSet.md | 108 + docs/docs/PaginatedCloudBackupRestoreJob.md | 108 + ...inatedCloudBackupShardedClusterSnapshot.md | 108 + docs/docs/PaginatedCloudProviderContainer.md | 108 + docs/docs/PaginatedClusterDescriptionV15.md | 108 + docs/docs/PaginatedDatabase.md | 108 + docs/docs/PaginatedDiskPartition.md | 108 + docs/docs/PaginatedGCPPeerVpc.md | 108 + docs/docs/PaginatedHostViewAtlas.md | 108 + docs/docs/PaginatedIntegration.md | 108 + docs/docs/PaginatedLegacyCluster.md | 108 + docs/docs/PaginatedNetworkAccess.md | 108 + docs/docs/PaginatedOnlineArchive.md | 108 + docs/docs/PaginatedOrgGroup.md | 108 + docs/docs/PaginatedOrganization.md | 108 + docs/docs/PaginatedPipelineRun.md | 108 + docs/docs/PaginatedPrivateLinkConnection.md | 108 + docs/docs/PaginatedRestoreJob.md | 108 + .../PaginatedServerlessInstanceDescription.md | 108 + docs/docs/PaginatedSnapshot.md | 108 + docs/docs/PaginatedTeam.md | 108 + docs/docs/PaginatedTeamRole.md | 108 + docs/docs/PaginatedTenantRestore.md | 108 + docs/docs/PaginatedTenantSnapshot.md | 108 + docs/docs/PaginatedUserCert.md | 108 + docs/docs/PartitionField.md | 98 + docs/docs/Payment.md | 238 ++ docs/docs/PemFileInfo.md | 82 + docs/docs/PemFileInfoView.md | 82 + docs/docs/PerformanceAdvisorApi.md | 416 +++ docs/docs/PerformanceAdvisorIndex.md | 186 ++ docs/docs/PerformanceAdvisorOpStats.md | 134 + docs/docs/PerformanceAdvisorOperation.md | 82 + docs/docs/PerformanceAdvisorResponse.md | 82 + docs/docs/PerformanceAdvisorShape.md | 186 ++ docs/docs/PerformanceAdvisorSlowQuery.md | 82 + docs/docs/PerformanceAdvisorSlowQueryList.md | 56 + docs/docs/PeriodicCpsSnapshotSource.md | 186 ++ docs/docs/PipelineRunStats.md | 82 + docs/docs/Policy.md | 82 + docs/docs/PolicyItem.md | 140 + docs/docs/PrivateEndpointServicesApi.md | 724 +++++ docs/docs/PrivateIPMode.md | 51 + docs/docs/PrivateNetworkEndpointIdEntry.md | 129 + docs/docs/ProgrammaticAPIKeysApi.md | 1130 ++++++++ docs/docs/ProjectIPAccessListApi.md | 404 +++ docs/docs/ProjectSettingItem.md | 51 + docs/docs/ProjectsApi.md | 1543 +++++++++++ docs/docs/Prometheus.md | 244 ++ docs/docs/ProviderRegions.md | 82 + docs/docs/RPUMetricThreshold.md | 160 ++ docs/docs/Raw.md | 290 +++ docs/docs/RawMetricAlert.md | 489 ++++ docs/docs/RawMetricEvent.md | 483 ++++ docs/docs/RawMetricThreshold.md | 160 ++ docs/docs/RawMetricUnits.md | 11 + docs/docs/RawMetricValue.md | 82 + docs/docs/Refund.md | 134 + docs/docs/RegionConfig.md | 264 ++ docs/docs/RegionSpec.md | 134 + .../ReplicaSetAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/ReplicaSetAlertViewForNdsGroup.md | 489 ++++ .../ReplicaSetEventTypeViewForNdsGroup.md | 21 + ...icaSetEventTypeViewForNdsGroupAlertable.md | 17 + ...TypeViewForNdsGroupAlertableNoThreshold.md | 13 + ...peViewForNdsGroupAlertableWithThreshold.md | 13 + docs/docs/ReplicaSetMatcher.md | 108 + docs/docs/ReplicaSetMatcherField.md | 15 + ...aSetThresholdAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/ReplicationSpec.md | 134 + docs/docs/RestoreJob.md | 493 ++++ docs/docs/RestoreJobDelivery.md | 337 +++ docs/docs/RestoreJobFileHash.md | 134 + docs/docs/Role.md | 93 + docs/docs/RoleAssignment.md | 108 + docs/docs/RoleMapping.md | 103 + docs/docs/RollingIndexApi.md | 86 + docs/docs/RootApi.md | 74 + docs/docs/SMSNotification.md | 129 + docs/docs/SampleDatasetStatus.md | 186 ++ docs/docs/ServerlessAWSTenantEndpoint.md | 212 ++ .../docs/ServerlessAWSTenantEndpointUpdate.md | 103 + docs/docs/ServerlessAzureTenantEndpoint.md | 264 ++ .../ServerlessAzureTenantEndpointUpdate.md | 129 + docs/docs/ServerlessBackupOptions.md | 56 + docs/docs/ServerlessBackupRestoreJob.md | 457 ++++ docs/docs/ServerlessBackupSnapshot.md | 290 +++ docs/docs/ServerlessEventTypeViewAlertable.md | 11 + docs/docs/ServerlessInstanceDescription.md | 311 +++ ...essInstanceDescriptionConnectionStrings.md | 82 + ...riptionConnectionStringsPrivateEndpoint.md | 108 + ...onnectionStringsPrivateEndpointEndpoint.md | 108 + .../ServerlessInstanceDescriptionCreate.md | 150 ++ .../ServerlessInstanceDescriptionUpdate.md | 82 + docs/docs/ServerlessInstancesApi.md | 400 +++ ...verlessMetricAlertConfigViewForNdsGroup.md | 285 ++ docs/docs/ServerlessMetricThreshold.md | 160 ++ docs/docs/ServerlessMetricUnits.md | 21 + docs/docs/ServerlessPrivateEndpointsApi.md | 409 +++ docs/docs/ServerlessProviderSettings.md | 98 + docs/docs/ServerlessTenantEndpoint.md | 264 ++ docs/docs/ServerlessTenantEndpointCreate.md | 56 + docs/docs/ServerlessTenantEndpointUpdate.md | 129 + docs/docs/SharedTierRestoreJobsApi.md | 247 ++ docs/docs/SharedTierSnapshotsApi.md | 247 ++ docs/docs/Slack.md | 134 + docs/docs/SlackNotification.md | 155 ++ docs/docs/Snapshot.md | 290 +++ docs/docs/SnapshotPart.md | 290 +++ docs/docs/SnapshotRetention.md | 98 + docs/docs/SnapshotSchedule.md | 245 ++ docs/docs/Source.md | 192 ++ docs/docs/SummaryNotification.md | 129 + docs/docs/SynonymSource.md | 51 + docs/docs/SystemStatus.md | 150 ++ docs/docs/TargetOrg.md | 51 + docs/docs/TargetOrgRequest.md | 56 + docs/docs/Team.md | 124 + docs/docs/TeamEvent.md | 379 +++ docs/docs/TeamEventType.md | 23 + docs/docs/TeamEventTypeViewForNdsGroup.md | 15 + docs/docs/TeamEventViewForNdsGroup.md | 379 +++ docs/docs/TeamNotification.md | 207 ++ docs/docs/TeamResponse.md | 108 + docs/docs/TeamRole.md | 108 + docs/docs/TeamsApi.md | 1033 ++++++++ docs/docs/TenantHardwareSpec.md | 56 + docs/docs/TenantRegionConfig.md | 160 ++ docs/docs/TenantRestore.md | 384 +++ docs/docs/TenantSnapshot.md | 238 ++ docs/docs/TestApi.md | 79 + docs/docs/ThirdPartyIntegrationsApi.md | 415 +++ docs/docs/ThresholdViewInteger.md | 108 + docs/docs/TimeMetricAlert.md | 489 ++++ docs/docs/TimeMetricEvent.md | 483 ++++ docs/docs/TimeMetricThreshold.md | 160 ++ docs/docs/TimeMetricUnits.md | 23 + docs/docs/TimeMetricValue.md | 82 + docs/docs/Toggle.md | 56 + docs/docs/TokenFilterasciiFolding.md | 77 + docs/docs/TokenFilterdaitchMokotoffSoundex.md | 77 + docs/docs/TokenFilteredgeGram.md | 119 + docs/docs/TokenFiltericuFolding.md | 51 + docs/docs/TokenFiltericuNormalizer.md | 77 + docs/docs/TokenFilterlength.md | 103 + docs/docs/TokenFilterlowercase.md | 51 + docs/docs/TokenFilternGram.md | 119 + docs/docs/TokenFilterregex.md | 114 + docs/docs/TokenFilterreverse.md | 51 + docs/docs/TokenFiltershingle.md | 93 + docs/docs/TokenFiltersnowballStemming.md | 72 + docs/docs/TokenFilterstopword.md | 98 + docs/docs/TokenFiltertrim.md | 51 + docs/docs/TokenizeredgeGram.md | 93 + docs/docs/Tokenizerkeyword.md | 51 + docs/docs/TokenizernGram.md | 93 + docs/docs/TokenizerregexCaptureGroup.md | 93 + docs/docs/TokenizerregexSplit.md | 72 + docs/docs/Tokenizerstandard.md | 77 + docs/docs/TokenizeruaxUrlEmail.md | 77 + docs/docs/Tokenizerwhitespace.md | 77 + docs/docs/TriggerIngestionRequest.md | 51 + docs/docs/UpdateCustomDBRole.md | 82 + docs/docs/UserAccessList.md | 212 ++ docs/docs/UserCert.md | 212 ++ docs/docs/UserEventTypeViewForNdsGroup.md | 25 + docs/docs/UserEventTypeViewForOrg.md | 27 + docs/docs/UserEventViewForNdsGroup.md | 379 +++ docs/docs/UserEventViewForOrg.md | 379 +++ docs/docs/UserNotification.md | 181 ++ docs/docs/UserRoleAssignment.md | 82 + docs/docs/UserScope.md | 72 + docs/docs/UserSecurity.md | 108 + docs/docs/Validation.md | 180 ++ docs/docs/VictorOps.md | 103 + docs/docs/VictorOpsNotification.md | 155 ++ docs/docs/Webhook.md | 103 + docs/docs/WebhookNotification.md | 155 ++ docs/docs/WeeklySchedule.md | 181 ++ docs/docs/X509AuthenticationApi.md | 245 ++ docs/docs/X509Certificate.md | 108 + docs/docs/X509CertificateView.md | 82 + docs/docs/ZoneMapping.md | 72 + tools/config/go-templates/api_doc.mustache | 2 +- 589 files changed, 116820 insertions(+), 3 deletions(-) create mode 100644 docs/docs/AWSAutoScaling.md create mode 100644 docs/docs/AWSCloudProviderContainer.md create mode 100644 docs/docs/AWSClustersDNSApi.md create mode 100644 docs/docs/AWSComputeAutoScaling.md create mode 100644 docs/docs/AWSCustomDNSEnabled.md create mode 100644 docs/docs/AWSHardwareSpec.md create mode 100644 docs/docs/AWSInterfaceEndpoint.md create mode 100644 docs/docs/AWSKMS.md create mode 100644 docs/docs/AWSPeerVpc.md create mode 100644 docs/docs/AWSPeerVpcRequest.md create mode 100644 docs/docs/AWSPrivateLinkConnection.md create mode 100644 docs/docs/AWSProviderSettings.md create mode 100644 docs/docs/AWSRegionConfig.md create mode 100644 docs/docs/AccessListItem.md create mode 100644 docs/docs/AddUserToTeam.md create mode 100644 docs/docs/Alert.md create mode 100644 docs/docs/AlertAudit.md create mode 100644 docs/docs/AlertAuditType.md create mode 100644 docs/docs/AlertConfig.md create mode 100644 docs/docs/AlertConfigAudit.md create mode 100644 docs/docs/AlertConfigAuditType.md create mode 100644 docs/docs/AlertConfigViewForNdsGroup.md create mode 100644 docs/docs/AlertConfigurationsApi.md create mode 100644 docs/docs/AlertViewForNdsGroup.md create mode 100644 docs/docs/AlertsApi.md create mode 100644 docs/docs/ApiAtlasPartitionFieldView.md create mode 100644 docs/docs/ApiInstanceSizeView.md create mode 100644 docs/docs/ApiRoleAssignmentView.md create mode 100644 docs/docs/ApiUser.md create mode 100644 docs/docs/ApiUserEventTypeViewForNdsGroup.md create mode 100644 docs/docs/ApiUserEventTypeViewForOrg.md create mode 100644 docs/docs/ApiUserEventViewForNdsGroup.md create mode 100644 docs/docs/ApiUserEventViewForOrg.md create mode 100644 docs/docs/AppServiceAlert.md create mode 100644 docs/docs/AppServiceAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/AppServiceEvent.md create mode 100644 docs/docs/AppServiceEventType.md create mode 100644 docs/docs/AppServiceEventTypeViewAlertable.md create mode 100644 docs/docs/AppServiceEventTypeViewAlertableNoThreshold.md create mode 100644 docs/docs/AppServiceEventTypeViewAlertableWithThreshold.md create mode 100644 docs/docs/AppServiceMetricAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/AppServiceMetricMatcher.md create mode 100644 docs/docs/AppServiceMetricMatcherField.md create mode 100644 docs/docs/AppServiceMetricThreshold.md create mode 100644 docs/docs/AppUser.md create mode 100644 docs/docs/AtlasSearchApi.md create mode 100644 docs/docs/AuditLog.md create mode 100644 docs/docs/AuditingApi.md create mode 100644 docs/docs/AutoExportPolicy.md create mode 100644 docs/docs/AutoScaling.md create mode 100644 docs/docs/AutoScalingV15.md create mode 100644 docs/docs/AutomationConfigEvent.md create mode 100644 docs/docs/AutomationConfigEventType.md create mode 100644 docs/docs/AvailableDeployment.md create mode 100644 docs/docs/AvailableProject.md create mode 100644 docs/docs/AvailableRegion.md create mode 100644 docs/docs/AzureAutoScaling.md create mode 100644 docs/docs/AzureCloudProviderContainer.md create mode 100644 docs/docs/AzureComputeAutoScaling.md create mode 100644 docs/docs/AzureHardwareSpec.md create mode 100644 docs/docs/AzureKeyVault.md create mode 100644 docs/docs/AzurePeerNetwork.md create mode 100644 docs/docs/AzurePeerNetworkRequest.md create mode 100644 docs/docs/AzurePrivateEndpoint.md create mode 100644 docs/docs/AzurePrivateLinkConnection.md create mode 100644 docs/docs/AzureProviderSettings.md create mode 100644 docs/docs/AzureRegionConfig.md create mode 100644 docs/docs/BSONTimestamp.md create mode 100644 docs/docs/BiConnector.md create mode 100644 docs/docs/BillingEventTypeViewAlertableWithThreshold.md create mode 100644 docs/docs/BillingEventTypeViewForNdsGroup.md create mode 100644 docs/docs/BillingEventTypeViewForOrg.md create mode 100644 docs/docs/BillingEventViewForNdsGroup.md create mode 100644 docs/docs/BillingEventViewForOrg.md create mode 100644 docs/docs/BillingThresholdAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/CharFilterhtmlStrip.md create mode 100644 docs/docs/CharFiltericuNormalize.md create mode 100644 docs/docs/CharFiltermapping.md create mode 100644 docs/docs/CharFiltermappingMappings.md create mode 100644 docs/docs/CharFilterpersian.md create mode 100644 docs/docs/Checkpoint.md create mode 100644 docs/docs/CheckpointPart.md create mode 100644 docs/docs/CloudBackupsApi.md create mode 100644 docs/docs/CloudMigrationServiceApi.md create mode 100644 docs/docs/CloudProviderAccess.md create mode 100644 docs/docs/CloudProviderAccessAWSIAMRole.md create mode 100644 docs/docs/CloudProviderAccessApi.md create mode 100644 docs/docs/CloudProviderAccessAzureServicePrincipal.md create mode 100644 docs/docs/CloudProviderAccessDataLakeFeatureUsage.md create mode 100644 docs/docs/CloudProviderAccessEncryptionAtRestFeatureUsage.md create mode 100644 docs/docs/CloudProviderAccessExportSnapshotFeatureUsage.md create mode 100644 docs/docs/CloudProviderAccessFeatureUsage.md create mode 100644 docs/docs/CloudProviderAccessFeatureUsageDataLakeFeatureId.md create mode 100644 docs/docs/CloudProviderAccessFeatureUsageExportSnapshotFeatureId.md create mode 100644 docs/docs/CloudProviderAccessRole.md create mode 100644 docs/docs/CloudProviderContainer.md create mode 100644 docs/docs/Cluster.md create mode 100644 docs/docs/ClusterAlert.md create mode 100644 docs/docs/ClusterAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/ClusterDescriptionConnectionStrings.md create mode 100644 docs/docs/ClusterDescriptionConnectionStringsPrivateEndpoint.md create mode 100644 docs/docs/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint.md create mode 100644 docs/docs/ClusterDescriptionProcessArgs.md create mode 100644 docs/docs/ClusterDescriptionV15.md create mode 100644 docs/docs/ClusterEventTypeViewAlertable.md create mode 100644 docs/docs/ClusterEventTypeViewForNdsGroup.md create mode 100644 docs/docs/ClusterEventViewForNdsGroup.md create mode 100644 docs/docs/ClusterMatcher.md create mode 100644 docs/docs/ClusterMatcherField.md create mode 100644 docs/docs/ClusterOutageSimulation.md create mode 100644 docs/docs/ClusterOutageSimulationApi.md create mode 100644 docs/docs/ClusterOutageSimulationOutageFilter.md create mode 100644 docs/docs/ClusterProviderSettings.md create mode 100644 docs/docs/ClusterStatus.md create mode 100644 docs/docs/ClustersApi.md create mode 100644 docs/docs/Collation.md create mode 100644 docs/docs/ComputeAutoScaling.md create mode 100644 docs/docs/ComputeAutoScalingV15.md create mode 100644 docs/docs/ConnectedOrgConfig.md create mode 100644 docs/docs/ContainerPeer.md create mode 100644 docs/docs/ContainerPeerViewRequest.md create mode 100644 docs/docs/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold.md create mode 100644 docs/docs/CpsBackupThresholdAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/CreateAWSEndpointRequest.md create mode 100644 docs/docs/CreateAWSEndpointRequestAllOf.md create mode 100644 docs/docs/CreateApiKey.md create mode 100644 docs/docs/CreateAzureEndpointRequest.md create mode 100644 docs/docs/CreateAzureEndpointRequestAllOf.md create mode 100644 docs/docs/CreateEndpointServiceRequest.md create mode 100644 docs/docs/CreateGCPEndpointGroupRequest.md create mode 100644 docs/docs/CreateGCPEndpointGroupRequestAllOf.md create mode 100644 docs/docs/CreateGCPForwardingRuleRequest.md create mode 100644 docs/docs/CreateOrganizationRequest.md create mode 100644 docs/docs/CreateOrganizationResponse.md create mode 100644 docs/docs/CreatePeeringConnection200Response.md create mode 100644 docs/docs/CreatePrivateEndpointRequest.md create mode 100644 docs/docs/Criteria.md create mode 100644 docs/docs/CustomCriteria.md create mode 100644 docs/docs/CustomDBRole.md create mode 100644 docs/docs/CustomDatabaseRolesApi.md create mode 100644 docs/docs/CustomZoneMappings.md create mode 100644 docs/docs/CustomerX509.md create mode 100644 docs/docs/DBAction.md create mode 100644 docs/docs/DBResource.md create mode 100644 docs/docs/DLSIngestionSink.md create mode 100644 docs/docs/DailySchedule.md create mode 100644 docs/docs/DataExplorerAccessedEvent.md create mode 100644 docs/docs/DataExplorerAccessedEventType.md create mode 100644 docs/docs/DataFederationApi.md create mode 100644 docs/docs/DataFederationQueryLimit.md create mode 100644 docs/docs/DataFederationTenantQueryLimit.md create mode 100644 docs/docs/DataLakeAWSCloudProviderConfig.md create mode 100644 docs/docs/DataLakeAtlasStore.md create mode 100644 docs/docs/DataLakeAtlasStoreReadPreference.md create mode 100644 docs/docs/DataLakeAtlasStoreReadPreferenceTag.md create mode 100644 docs/docs/DataLakeCloudProviderConfig.md create mode 100644 docs/docs/DataLakeDataProcessRegion.md create mode 100644 docs/docs/DataLakeDatabase.md create mode 100644 docs/docs/DataLakeDatabaseCollection.md create mode 100644 docs/docs/DataLakeDatabaseDataSource.md create mode 100644 docs/docs/DataLakeHTTPStore.md create mode 100644 docs/docs/DataLakeOnlineArchiveStore.md create mode 100644 docs/docs/DataLakePipelinesApi.md create mode 100644 docs/docs/DataLakeRegion.md create mode 100644 docs/docs/DataLakeS3Store.md create mode 100644 docs/docs/DataLakeStorage.md create mode 100644 docs/docs/DataLakeStore.md create mode 100644 docs/docs/DataLakeTenant.md create mode 100644 docs/docs/DataLakeView.md create mode 100644 docs/docs/DataMetricAlert.md create mode 100644 docs/docs/DataMetricEvent.md create mode 100644 docs/docs/DataMetricThreshold.md create mode 100644 docs/docs/DataMetricUnits.md create mode 100644 docs/docs/DataMetricValue.md create mode 100644 docs/docs/DataProtectionSettings.md create mode 100644 docs/docs/Database.md create mode 100644 docs/docs/DatabaseUser.md create mode 100644 docs/docs/DatabaseUsersApi.md create mode 100644 docs/docs/Datadog.md create mode 100644 docs/docs/DatadogNotification.md create mode 100644 docs/docs/DateCriteria.md create mode 100644 docs/docs/DedicatedHardwareSpec.md create mode 100644 docs/docs/DefaultAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/DefaultAlertViewForNdsGroup.md create mode 100644 docs/docs/DefaultEventViewForNdsGroup.md create mode 100644 docs/docs/DefaultEventViewForOrg.md create mode 100644 docs/docs/DefaultLimit.md create mode 100644 docs/docs/DefaultSchedule.md create mode 100644 docs/docs/DeleteCopiedBackups.md create mode 100644 docs/docs/Destination.md create mode 100644 docs/docs/DiskBackupBaseRestoreMember.md create mode 100644 docs/docs/DiskBackupCopySetting.md create mode 100644 docs/docs/DiskBackupExportJob.md create mode 100644 docs/docs/DiskBackupExportJobRequest.md create mode 100644 docs/docs/DiskBackupOnDemandSnapshotRequest.md create mode 100644 docs/docs/DiskBackupReplicaSet.md create mode 100644 docs/docs/DiskBackupRestoreJob.md create mode 100644 docs/docs/DiskBackupShardedClusterSnapshot.md create mode 100644 docs/docs/DiskBackupShardedClusterSnapshotMember.md create mode 100644 docs/docs/DiskBackupSnapshot.md create mode 100644 docs/docs/DiskBackupSnapshotAWSExportBucket.md create mode 100644 docs/docs/DiskBackupSnapshotSchedule.md create mode 100644 docs/docs/DiskGBAutoScaling.md create mode 100644 docs/docs/DiskPartition.md create mode 100644 docs/docs/EmailNotification.md create mode 100644 docs/docs/EncryptionAtRest.md create mode 100644 docs/docs/EncryptionAtRestUsingCustomerKeyManagementApi.md create mode 100644 docs/docs/EncryptionKeyAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/EncryptionKeyEventTypeViewAlertable.md create mode 100644 docs/docs/Endpoint.md create mode 100644 docs/docs/EndpointService.md create mode 100644 docs/docs/Error.md create mode 100644 docs/docs/EventTypeForNdsGroup.md create mode 100644 docs/docs/EventTypeForOrg.md create mode 100644 docs/docs/EventViewForNdsGroup.md create mode 100644 docs/docs/EventViewForOrg.md create mode 100644 docs/docs/EventsApi.md create mode 100644 docs/docs/ExampleResourceResponseView20230101.md create mode 100644 docs/docs/ExampleResourceResponseView20230201.md create mode 100644 docs/docs/ExportStatus.md create mode 100644 docs/docs/FTSAnalyzers.md create mode 100644 docs/docs/FTSAnalyzersCharFiltersInner.md create mode 100644 docs/docs/FTSAnalyzersTokenFiltersInner.md create mode 100644 docs/docs/FTSAnalyzersTokenizer.md create mode 100644 docs/docs/FTSIndex.md create mode 100644 docs/docs/FTSIndexAudit.md create mode 100644 docs/docs/FTSIndexAuditType.md create mode 100644 docs/docs/FTSMappings.md create mode 100644 docs/docs/FTSMetric.md create mode 100644 docs/docs/FTSMetrics.md create mode 100644 docs/docs/FTSSynonymMappingDefinition.md create mode 100644 docs/docs/FederatedAuthenticationApi.md create mode 100644 docs/docs/FederatedUser.md create mode 100644 docs/docs/FieldTransformation.md create mode 100644 docs/docs/ForNdsGroup.md create mode 100644 docs/docs/FreeAutoScaling.md create mode 100644 docs/docs/FreeProviderSettings.md create mode 100644 docs/docs/GCPAutoScaling.md create mode 100644 docs/docs/GCPCloudProviderContainer.md create mode 100644 docs/docs/GCPComputeAutoScaling.md create mode 100644 docs/docs/GCPConsumerForwardingRule.md create mode 100644 docs/docs/GCPEndpointGroup.md create mode 100644 docs/docs/GCPEndpointService.md create mode 100644 docs/docs/GCPHardwareSpec.md create mode 100644 docs/docs/GCPPeerVpc.md create mode 100644 docs/docs/GCPPeerVpcRequest.md create mode 100644 docs/docs/GCPProviderSettings.md create mode 100644 docs/docs/GCPRegionConfig.md create mode 100644 docs/docs/GeoSharding.md create mode 100644 docs/docs/GetPeeringConnection200Response.md create mode 100644 docs/docs/GlobalClustersApi.md create mode 100644 docs/docs/GoogleCloudKMS.md create mode 100644 docs/docs/GreaterThanDaysThreshold.md create mode 100644 docs/docs/GreaterThanRawThreshold.md create mode 100644 docs/docs/GreaterThanRawThresholdAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/GreaterThanTimeThreshold.md create mode 100644 docs/docs/Group.md create mode 100644 docs/docs/GroupInvitation.md create mode 100644 docs/docs/GroupInvitationRequest.md create mode 100644 docs/docs/GroupInvitationUpdateRequest.md create mode 100644 docs/docs/GroupMaintenanceWindow.md create mode 100644 docs/docs/GroupName.md create mode 100644 docs/docs/GroupNotification.md create mode 100644 docs/docs/GroupPaginatedEvent.md create mode 100644 docs/docs/GroupSettings.md create mode 100644 docs/docs/HardwareSpec.md create mode 100644 docs/docs/HipChatNotification.md create mode 100644 docs/docs/HostAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/HostAlertViewForNdsGroup.md create mode 100644 docs/docs/HostEventTypeViewForNdsGroup.md create mode 100644 docs/docs/HostEventTypeViewForNdsGroupAlertable.md create mode 100644 docs/docs/HostEventViewForNdsGroup.md create mode 100644 docs/docs/HostMatcher.md create mode 100644 docs/docs/HostMatcherField.md create mode 100644 docs/docs/HostMetricAlert.md create mode 100644 docs/docs/HostMetricAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/HostMetricEvent.md create mode 100644 docs/docs/HostMetricEventType.md create mode 100644 docs/docs/HostMetricEventTypeViewAlertable.md create mode 100644 docs/docs/HostMetricThreshold.md create mode 100644 docs/docs/HostMetricValue.md create mode 100644 docs/docs/HostViewAtlas.md create mode 100644 docs/docs/IdentityProvider.md create mode 100644 docs/docs/IdentityProviderUpdate.md create mode 100644 docs/docs/IndexOptions.md create mode 100644 docs/docs/IndexRequest.md create mode 100644 docs/docs/IngestionPipeline.md create mode 100644 docs/docs/IngestionPipelineRun.md create mode 100644 docs/docs/IngestionSink.md create mode 100644 docs/docs/IngestionSource.md create mode 100644 docs/docs/InheritedRole.md create mode 100644 docs/docs/InstanceSize.md create mode 100644 docs/docs/Integration.md create mode 100644 docs/docs/Invoice.md create mode 100644 docs/docs/InvoicesApi.md create mode 100644 docs/docs/Key.md create mode 100644 docs/docs/LDAPConfigurationApi.md create mode 100644 docs/docs/Label.md create mode 100644 docs/docs/LegacyBackupApi.md create mode 100644 docs/docs/LegacyBackupRestoreJobsApi.md create mode 100644 docs/docs/LegacyClusterDescription.md create mode 100644 docs/docs/LegacyReplicationSpec.md create mode 100644 docs/docs/LessThanDaysThreshold.md create mode 100644 docs/docs/LessThanTimeThreshold.md create mode 100644 docs/docs/LessThanTimeThresholdAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/Limit.md create mode 100644 docs/docs/LineItem.md create mode 100644 docs/docs/Link.md create mode 100644 docs/docs/LinkAtlas.md create mode 100644 docs/docs/ListPeeringConnections200Response.md create mode 100644 docs/docs/LiveMigrationRequest.md create mode 100644 docs/docs/LiveMigrationResponse.md create mode 100644 docs/docs/MaintenanceWindowsApi.md create mode 100644 docs/docs/ManagedNamespace.md create mode 100644 docs/docs/ManagedNamespaces.md create mode 100644 docs/docs/MatcherField.md create mode 100644 docs/docs/MatcherHostType.md create mode 100644 docs/docs/Measurement.md create mode 100644 docs/docs/MeasurementViewAtlas.md create mode 100644 docs/docs/MeasurementsGeneralViewAtlas.md create mode 100644 docs/docs/MeasurementsIndexes.md create mode 100644 docs/docs/MeasurementsNonIndex.md create mode 100644 docs/docs/MetricDataPoint.md create mode 100644 docs/docs/MetricDataPointViewAtlas.md create mode 100644 docs/docs/MicrosoftTeams.md create mode 100644 docs/docs/MicrosoftTeamsNotification.md create mode 100644 docs/docs/MongoDBAccessLogs.md create mode 100644 docs/docs/MongoDBAccessLogsList.md create mode 100644 docs/docs/MongoDBCloudUsersApi.md create mode 100644 docs/docs/MonitoringAndLogsApi.md create mode 100644 docs/docs/MonthlySchedule.md create mode 100644 docs/docs/MultiCloudClustersApi.md create mode 100644 docs/docs/NDSAuditTypeViewForNdsGroup.md create mode 100644 docs/docs/NDSAuditTypeViewForOrg.md create mode 100644 docs/docs/NDSAuditViewForNdsGroup.md create mode 100644 docs/docs/NDSAuditViewForOrg.md create mode 100644 docs/docs/NDSAutoScalingAuditTypeViewForNdsGroup.md create mode 100644 docs/docs/NDSAutoScalingAuditViewForNdsGroup.md create mode 100644 docs/docs/NDSLDAP.md create mode 100644 docs/docs/NDSLDAPVerifyConnectivityJobRequest.md create mode 100644 docs/docs/NDSLDAPVerifyConnectivityJobRequestParams.md create mode 100644 docs/docs/NDSLDAPVerifyConnectivityJobRequestValidation.md create mode 100644 docs/docs/NDSLabel.md create mode 100644 docs/docs/NDSNotification.md create mode 100644 docs/docs/NDSServerlessInstanceAudit.md create mode 100644 docs/docs/NDSServerlessInstanceAuditType.md create mode 100644 docs/docs/NDSTenantEndpointAudit.md create mode 100644 docs/docs/NDSTenantEndpointAuditType.md create mode 100644 docs/docs/NDSUserToDNMapping.md create mode 100644 docs/docs/NDSX509UserAuthenticationAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/NDSX509UserAuthenticationEventTypeViewAlertable.md create mode 100644 docs/docs/NamespaceObj.md create mode 100644 docs/docs/Namespaces.md create mode 100644 docs/docs/NetPeerRequestBase.md create mode 100644 docs/docs/NetworkPeeringApi.md create mode 100644 docs/docs/NetworkPermissionEntry.md create mode 100644 docs/docs/NetworkPermissionEntryStatus.md create mode 100644 docs/docs/NewRelic.md create mode 100644 docs/docs/Notification.md create mode 100644 docs/docs/NotificationViewForNdsGroup.md create mode 100644 docs/docs/NumberMetricAlert.md create mode 100644 docs/docs/NumberMetricEvent.md create mode 100644 docs/docs/NumberMetricThreshold.md create mode 100644 docs/docs/NumberMetricUnits.md create mode 100644 docs/docs/NumberMetricValue.md create mode 100644 docs/docs/OnDemandCpsSnapshotSource.md create mode 100644 docs/docs/OnlineArchive.md create mode 100644 docs/docs/OnlineArchiveApi.md create mode 100644 docs/docs/OnlineArchiveSchedule.md create mode 100644 docs/docs/Operator.md create mode 100644 docs/docs/OpsGenie.md create mode 100644 docs/docs/OpsGenieNotification.md create mode 100644 docs/docs/OrgEventTypeViewForOrg.md create mode 100644 docs/docs/OrgEventViewForOrg.md create mode 100644 docs/docs/OrgFederationSettings.md create mode 100644 docs/docs/OrgGroup.md create mode 100644 docs/docs/OrgNotification.md create mode 100644 docs/docs/OrgPaginatedEvent.md create mode 100644 docs/docs/Organization.md create mode 100644 docs/docs/OrganizationInvitation.md create mode 100644 docs/docs/OrganizationInvitationRequest.md create mode 100644 docs/docs/OrganizationInvitationUpdateRequest.md create mode 100644 docs/docs/OrganizationSettings.md create mode 100644 docs/docs/OrganizationsApi.md create mode 100644 docs/docs/PagerDuty.md create mode 100644 docs/docs/PagerDutyNotification.md create mode 100644 docs/docs/PaginatedAWSPeerVpc.md create mode 100644 docs/docs/PaginatedAlert.md create mode 100644 docs/docs/PaginatedAlertConfig.md create mode 100644 docs/docs/PaginatedApiApiUser.md create mode 100644 docs/docs/PaginatedApiAppUser.md create mode 100644 docs/docs/PaginatedApiAtlasCheckpoint.md create mode 100644 docs/docs/PaginatedApiAtlasDatabaseUser.md create mode 100644 docs/docs/PaginatedApiAtlasDiskBackupExportJob.md create mode 100644 docs/docs/PaginatedApiAtlasProviderRegions.md create mode 100644 docs/docs/PaginatedApiAtlasServerlessBackupRestoreJob.md create mode 100644 docs/docs/PaginatedApiAtlasServerlessBackupSnapshot.md create mode 100644 docs/docs/PaginatedApiInvoice.md create mode 100644 docs/docs/PaginatedApiUserAccessList.md create mode 100644 docs/docs/PaginatedAppUser.md create mode 100644 docs/docs/PaginatedAtlasGroup.md create mode 100644 docs/docs/PaginatedAzurePeerNetwork.md create mode 100644 docs/docs/PaginatedBackupSnapshot.md create mode 100644 docs/docs/PaginatedBackupSnapshotExportBucket.md create mode 100644 docs/docs/PaginatedCloudBackupReplicaSet.md create mode 100644 docs/docs/PaginatedCloudBackupRestoreJob.md create mode 100644 docs/docs/PaginatedCloudBackupShardedClusterSnapshot.md create mode 100644 docs/docs/PaginatedCloudProviderContainer.md create mode 100644 docs/docs/PaginatedClusterDescriptionV15.md create mode 100644 docs/docs/PaginatedDatabase.md create mode 100644 docs/docs/PaginatedDiskPartition.md create mode 100644 docs/docs/PaginatedGCPPeerVpc.md create mode 100644 docs/docs/PaginatedHostViewAtlas.md create mode 100644 docs/docs/PaginatedIntegration.md create mode 100644 docs/docs/PaginatedLegacyCluster.md create mode 100644 docs/docs/PaginatedNetworkAccess.md create mode 100644 docs/docs/PaginatedOnlineArchive.md create mode 100644 docs/docs/PaginatedOrgGroup.md create mode 100644 docs/docs/PaginatedOrganization.md create mode 100644 docs/docs/PaginatedPipelineRun.md create mode 100644 docs/docs/PaginatedPrivateLinkConnection.md create mode 100644 docs/docs/PaginatedRestoreJob.md create mode 100644 docs/docs/PaginatedServerlessInstanceDescription.md create mode 100644 docs/docs/PaginatedSnapshot.md create mode 100644 docs/docs/PaginatedTeam.md create mode 100644 docs/docs/PaginatedTeamRole.md create mode 100644 docs/docs/PaginatedTenantRestore.md create mode 100644 docs/docs/PaginatedTenantSnapshot.md create mode 100644 docs/docs/PaginatedUserCert.md create mode 100644 docs/docs/PartitionField.md create mode 100644 docs/docs/Payment.md create mode 100644 docs/docs/PemFileInfo.md create mode 100644 docs/docs/PemFileInfoView.md create mode 100644 docs/docs/PerformanceAdvisorApi.md create mode 100644 docs/docs/PerformanceAdvisorIndex.md create mode 100644 docs/docs/PerformanceAdvisorOpStats.md create mode 100644 docs/docs/PerformanceAdvisorOperation.md create mode 100644 docs/docs/PerformanceAdvisorResponse.md create mode 100644 docs/docs/PerformanceAdvisorShape.md create mode 100644 docs/docs/PerformanceAdvisorSlowQuery.md create mode 100644 docs/docs/PerformanceAdvisorSlowQueryList.md create mode 100644 docs/docs/PeriodicCpsSnapshotSource.md create mode 100644 docs/docs/PipelineRunStats.md create mode 100644 docs/docs/Policy.md create mode 100644 docs/docs/PolicyItem.md create mode 100644 docs/docs/PrivateEndpointServicesApi.md create mode 100644 docs/docs/PrivateIPMode.md create mode 100644 docs/docs/PrivateNetworkEndpointIdEntry.md create mode 100644 docs/docs/ProgrammaticAPIKeysApi.md create mode 100644 docs/docs/ProjectIPAccessListApi.md create mode 100644 docs/docs/ProjectSettingItem.md create mode 100644 docs/docs/ProjectsApi.md create mode 100644 docs/docs/Prometheus.md create mode 100644 docs/docs/ProviderRegions.md create mode 100644 docs/docs/RPUMetricThreshold.md create mode 100644 docs/docs/Raw.md create mode 100644 docs/docs/RawMetricAlert.md create mode 100644 docs/docs/RawMetricEvent.md create mode 100644 docs/docs/RawMetricThreshold.md create mode 100644 docs/docs/RawMetricUnits.md create mode 100644 docs/docs/RawMetricValue.md create mode 100644 docs/docs/Refund.md create mode 100644 docs/docs/RegionConfig.md create mode 100644 docs/docs/RegionSpec.md create mode 100644 docs/docs/ReplicaSetAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/ReplicaSetAlertViewForNdsGroup.md create mode 100644 docs/docs/ReplicaSetEventTypeViewForNdsGroup.md create mode 100644 docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertable.md create mode 100644 docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold.md create mode 100644 docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold.md create mode 100644 docs/docs/ReplicaSetMatcher.md create mode 100644 docs/docs/ReplicaSetMatcherField.md create mode 100644 docs/docs/ReplicaSetThresholdAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/ReplicationSpec.md create mode 100644 docs/docs/RestoreJob.md create mode 100644 docs/docs/RestoreJobDelivery.md create mode 100644 docs/docs/RestoreJobFileHash.md create mode 100644 docs/docs/Role.md create mode 100644 docs/docs/RoleAssignment.md create mode 100644 docs/docs/RoleMapping.md create mode 100644 docs/docs/RollingIndexApi.md create mode 100644 docs/docs/RootApi.md create mode 100644 docs/docs/SMSNotification.md create mode 100644 docs/docs/SampleDatasetStatus.md create mode 100644 docs/docs/ServerlessAWSTenantEndpoint.md create mode 100644 docs/docs/ServerlessAWSTenantEndpointUpdate.md create mode 100644 docs/docs/ServerlessAzureTenantEndpoint.md create mode 100644 docs/docs/ServerlessAzureTenantEndpointUpdate.md create mode 100644 docs/docs/ServerlessBackupOptions.md create mode 100644 docs/docs/ServerlessBackupRestoreJob.md create mode 100644 docs/docs/ServerlessBackupSnapshot.md create mode 100644 docs/docs/ServerlessEventTypeViewAlertable.md create mode 100644 docs/docs/ServerlessInstanceDescription.md create mode 100644 docs/docs/ServerlessInstanceDescriptionConnectionStrings.md create mode 100644 docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint.md create mode 100644 docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint.md create mode 100644 docs/docs/ServerlessInstanceDescriptionCreate.md create mode 100644 docs/docs/ServerlessInstanceDescriptionUpdate.md create mode 100644 docs/docs/ServerlessInstancesApi.md create mode 100644 docs/docs/ServerlessMetricAlertConfigViewForNdsGroup.md create mode 100644 docs/docs/ServerlessMetricThreshold.md create mode 100644 docs/docs/ServerlessMetricUnits.md create mode 100644 docs/docs/ServerlessPrivateEndpointsApi.md create mode 100644 docs/docs/ServerlessProviderSettings.md create mode 100644 docs/docs/ServerlessTenantEndpoint.md create mode 100644 docs/docs/ServerlessTenantEndpointCreate.md create mode 100644 docs/docs/ServerlessTenantEndpointUpdate.md create mode 100644 docs/docs/SharedTierRestoreJobsApi.md create mode 100644 docs/docs/SharedTierSnapshotsApi.md create mode 100644 docs/docs/Slack.md create mode 100644 docs/docs/SlackNotification.md create mode 100644 docs/docs/Snapshot.md create mode 100644 docs/docs/SnapshotPart.md create mode 100644 docs/docs/SnapshotRetention.md create mode 100644 docs/docs/SnapshotSchedule.md create mode 100644 docs/docs/Source.md create mode 100644 docs/docs/SummaryNotification.md create mode 100644 docs/docs/SynonymSource.md create mode 100644 docs/docs/SystemStatus.md create mode 100644 docs/docs/TargetOrg.md create mode 100644 docs/docs/TargetOrgRequest.md create mode 100644 docs/docs/Team.md create mode 100644 docs/docs/TeamEvent.md create mode 100644 docs/docs/TeamEventType.md create mode 100644 docs/docs/TeamEventTypeViewForNdsGroup.md create mode 100644 docs/docs/TeamEventViewForNdsGroup.md create mode 100644 docs/docs/TeamNotification.md create mode 100644 docs/docs/TeamResponse.md create mode 100644 docs/docs/TeamRole.md create mode 100644 docs/docs/TeamsApi.md create mode 100644 docs/docs/TenantHardwareSpec.md create mode 100644 docs/docs/TenantRegionConfig.md create mode 100644 docs/docs/TenantRestore.md create mode 100644 docs/docs/TenantSnapshot.md create mode 100644 docs/docs/TestApi.md create mode 100644 docs/docs/ThirdPartyIntegrationsApi.md create mode 100644 docs/docs/ThresholdViewInteger.md create mode 100644 docs/docs/TimeMetricAlert.md create mode 100644 docs/docs/TimeMetricEvent.md create mode 100644 docs/docs/TimeMetricThreshold.md create mode 100644 docs/docs/TimeMetricUnits.md create mode 100644 docs/docs/TimeMetricValue.md create mode 100644 docs/docs/Toggle.md create mode 100644 docs/docs/TokenFilterasciiFolding.md create mode 100644 docs/docs/TokenFilterdaitchMokotoffSoundex.md create mode 100644 docs/docs/TokenFilteredgeGram.md create mode 100644 docs/docs/TokenFiltericuFolding.md create mode 100644 docs/docs/TokenFiltericuNormalizer.md create mode 100644 docs/docs/TokenFilterlength.md create mode 100644 docs/docs/TokenFilterlowercase.md create mode 100644 docs/docs/TokenFilternGram.md create mode 100644 docs/docs/TokenFilterregex.md create mode 100644 docs/docs/TokenFilterreverse.md create mode 100644 docs/docs/TokenFiltershingle.md create mode 100644 docs/docs/TokenFiltersnowballStemming.md create mode 100644 docs/docs/TokenFilterstopword.md create mode 100644 docs/docs/TokenFiltertrim.md create mode 100644 docs/docs/TokenizeredgeGram.md create mode 100644 docs/docs/Tokenizerkeyword.md create mode 100644 docs/docs/TokenizernGram.md create mode 100644 docs/docs/TokenizerregexCaptureGroup.md create mode 100644 docs/docs/TokenizerregexSplit.md create mode 100644 docs/docs/Tokenizerstandard.md create mode 100644 docs/docs/TokenizeruaxUrlEmail.md create mode 100644 docs/docs/Tokenizerwhitespace.md create mode 100644 docs/docs/TriggerIngestionRequest.md create mode 100644 docs/docs/UpdateCustomDBRole.md create mode 100644 docs/docs/UserAccessList.md create mode 100644 docs/docs/UserCert.md create mode 100644 docs/docs/UserEventTypeViewForNdsGroup.md create mode 100644 docs/docs/UserEventTypeViewForOrg.md create mode 100644 docs/docs/UserEventViewForNdsGroup.md create mode 100644 docs/docs/UserEventViewForOrg.md create mode 100644 docs/docs/UserNotification.md create mode 100644 docs/docs/UserRoleAssignment.md create mode 100644 docs/docs/UserScope.md create mode 100644 docs/docs/UserSecurity.md create mode 100644 docs/docs/Validation.md create mode 100644 docs/docs/VictorOps.md create mode 100644 docs/docs/VictorOpsNotification.md create mode 100644 docs/docs/Webhook.md create mode 100644 docs/docs/WebhookNotification.md create mode 100644 docs/docs/WeeklySchedule.md create mode 100644 docs/docs/X509AuthenticationApi.md create mode 100644 docs/docs/X509Certificate.md create mode 100644 docs/docs/X509CertificateView.md create mode 100644 docs/docs/ZoneMapping.md diff --git a/docs/docs/AWSAutoScaling.md b/docs/docs/AWSAutoScaling.md new file mode 100644 index 00000000..e0829f44 --- /dev/null +++ b/docs/docs/AWSAutoScaling.md @@ -0,0 +1,56 @@ +# AWSAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Compute** | Pointer to [**AWSComputeAutoScaling**](AWSComputeAutoScaling.md) | | [optional] + +## Methods + +### NewAWSAutoScaling + +`func NewAWSAutoScaling() *AWSAutoScaling` + +NewAWSAutoScaling instantiates a new AWSAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSAutoScalingWithDefaults + +`func NewAWSAutoScalingWithDefaults() *AWSAutoScaling` + +NewAWSAutoScalingWithDefaults instantiates a new AWSAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCompute + +`func (o *AWSAutoScaling) GetCompute() AWSComputeAutoScaling` + +GetCompute returns the Compute field if non-nil, zero value otherwise. + +### GetComputeOk + +`func (o *AWSAutoScaling) GetComputeOk() (*AWSComputeAutoScaling, bool)` + +GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompute + +`func (o *AWSAutoScaling) SetCompute(v AWSComputeAutoScaling)` + +SetCompute sets Compute field to given value. + +### HasCompute + +`func (o *AWSAutoScaling) HasCompute() bool` + +HasCompute returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSCloudProviderContainer.md b/docs/docs/AWSCloudProviderContainer.md new file mode 100644 index 00000000..14d28176 --- /dev/null +++ b/docs/docs/AWSCloudProviderContainer.md @@ -0,0 +1,181 @@ +# AWSCloudProviderContainer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AtlasCidrBlock** | Pointer to **string** | IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. | [optional] +**RegionName** | **string** | Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. | +**VpcId** | Pointer to **string** | Unique string that identifies the MongoDB Cloud VPC on AWS. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering container. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering containers. | [optional] +**Provisioned** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. | [optional] [readonly] + +## Methods + +### NewAWSCloudProviderContainer + +`func NewAWSCloudProviderContainer(regionName string, ) *AWSCloudProviderContainer` + +NewAWSCloudProviderContainer instantiates a new AWSCloudProviderContainer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSCloudProviderContainerWithDefaults + +`func NewAWSCloudProviderContainerWithDefaults() *AWSCloudProviderContainer` + +NewAWSCloudProviderContainerWithDefaults instantiates a new AWSCloudProviderContainer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAtlasCidrBlock + +`func (o *AWSCloudProviderContainer) GetAtlasCidrBlock() string` + +GetAtlasCidrBlock returns the AtlasCidrBlock field if non-nil, zero value otherwise. + +### GetAtlasCidrBlockOk + +`func (o *AWSCloudProviderContainer) GetAtlasCidrBlockOk() (*string, bool)` + +GetAtlasCidrBlockOk returns a tuple with the AtlasCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasCidrBlock + +`func (o *AWSCloudProviderContainer) SetAtlasCidrBlock(v string)` + +SetAtlasCidrBlock sets AtlasCidrBlock field to given value. + +### HasAtlasCidrBlock + +`func (o *AWSCloudProviderContainer) HasAtlasCidrBlock() bool` + +HasAtlasCidrBlock returns a boolean if a field has been set. + +### GetRegionName + +`func (o *AWSCloudProviderContainer) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *AWSCloudProviderContainer) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *AWSCloudProviderContainer) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + + +### GetVpcId + +`func (o *AWSCloudProviderContainer) GetVpcId() string` + +GetVpcId returns the VpcId field if non-nil, zero value otherwise. + +### GetVpcIdOk + +`func (o *AWSCloudProviderContainer) GetVpcIdOk() (*string, bool)` + +GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVpcId + +`func (o *AWSCloudProviderContainer) SetVpcId(v string)` + +SetVpcId sets VpcId field to given value. + +### HasVpcId + +`func (o *AWSCloudProviderContainer) HasVpcId() bool` + +HasVpcId returns a boolean if a field has been set. + +### GetId + +`func (o *AWSCloudProviderContainer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AWSCloudProviderContainer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AWSCloudProviderContainer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AWSCloudProviderContainer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AWSCloudProviderContainer) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AWSCloudProviderContainer) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AWSCloudProviderContainer) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *AWSCloudProviderContainer) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetProvisioned + +`func (o *AWSCloudProviderContainer) GetProvisioned() bool` + +GetProvisioned returns the Provisioned field if non-nil, zero value otherwise. + +### GetProvisionedOk + +`func (o *AWSCloudProviderContainer) GetProvisionedOk() (*bool, bool)` + +GetProvisionedOk returns a tuple with the Provisioned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioned + +`func (o *AWSCloudProviderContainer) SetProvisioned(v bool)` + +SetProvisioned sets Provisioned field to given value. + +### HasProvisioned + +`func (o *AWSCloudProviderContainer) HasProvisioned() bool` + +HasProvisioned returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSClustersDNSApi.md b/docs/docs/AWSClustersDNSApi.md new file mode 100644 index 00000000..dabbf347 --- /dev/null +++ b/docs/docs/AWSClustersDNSApi.md @@ -0,0 +1,160 @@ +# \AWSClustersDNSApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetAWSCustomDNS**](AWSClustersDNSApi.md#GetAWSCustomDNS) | **Get** /api/atlas/v2/groups/{groupId}/awsCustomDNS | Return One Custom DNS Configuration for Atlas Clusters on AWS +[**ToggleAWSCustomDNS**](AWSClustersDNSApi.md#ToggleAWSCustomDNS) | **Patch** /api/atlas/v2/groups/{groupId}/awsCustomDNS | Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS + + + +## GetAWSCustomDNS + +> AWSCustomDNSEnabled GetAWSCustomDNS(ctx, groupId).Execute() + +Return One Custom DNS Configuration for Atlas Clusters on AWS + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.AWSClustersDNSApi.GetAWSCustomDNS(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AWSClustersDNSApi.GetAWSCustomDNS``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetAWSCustomDNS`: AWSCustomDNSEnabled + fmt.Fprintf(os.Stdout, "Response from `AWSClustersDNSApi.GetAWSCustomDNS`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAWSCustomDNSRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AWSCustomDNSEnabled**](AWSCustomDNSEnabled.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ToggleAWSCustomDNS + +> AWSCustomDNSEnabled ToggleAWSCustomDNS(ctx, groupId).AWSCustomDNSEnabled(aWSCustomDNSEnabled).Execute() + +Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + aWSCustomDNSEnabled := *openapiclient.NewAWSCustomDNSEnabled(false) // AWSCustomDNSEnabled | + + resp, r, err := sdk.AWSClustersDNSApi.ToggleAWSCustomDNS(context.Background(), groupId).AWSCustomDNSEnabled(aWSCustomDNSEnabled).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AWSClustersDNSApi.ToggleAWSCustomDNS``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ToggleAWSCustomDNS`: AWSCustomDNSEnabled + fmt.Fprintf(os.Stdout, "Response from `AWSClustersDNSApi.ToggleAWSCustomDNS`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiToggleAWSCustomDNSRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **aWSCustomDNSEnabled** | [**AWSCustomDNSEnabled**](AWSCustomDNSEnabled.md) | Enables or disables the custom DNS configuration for AWS clusters in the specified project. | + +### Return type + +[**AWSCustomDNSEnabled**](AWSCustomDNSEnabled.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/AWSComputeAutoScaling.md b/docs/docs/AWSComputeAutoScaling.md new file mode 100644 index 00000000..e6224d18 --- /dev/null +++ b/docs/docs/AWSComputeAutoScaling.md @@ -0,0 +1,82 @@ +# AWSComputeAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxInstanceSize** | Pointer to **string** | Maximum instance size to which your cluster can automatically scale. | [optional] +**MinInstanceSize** | Pointer to **string** | Minimum instance size to which your cluster can automatically scale. | [optional] + +## Methods + +### NewAWSComputeAutoScaling + +`func NewAWSComputeAutoScaling() *AWSComputeAutoScaling` + +NewAWSComputeAutoScaling instantiates a new AWSComputeAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSComputeAutoScalingWithDefaults + +`func NewAWSComputeAutoScalingWithDefaults() *AWSComputeAutoScaling` + +NewAWSComputeAutoScalingWithDefaults instantiates a new AWSComputeAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxInstanceSize + +`func (o *AWSComputeAutoScaling) GetMaxInstanceSize() string` + +GetMaxInstanceSize returns the MaxInstanceSize field if non-nil, zero value otherwise. + +### GetMaxInstanceSizeOk + +`func (o *AWSComputeAutoScaling) GetMaxInstanceSizeOk() (*string, bool)` + +GetMaxInstanceSizeOk returns a tuple with the MaxInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxInstanceSize + +`func (o *AWSComputeAutoScaling) SetMaxInstanceSize(v string)` + +SetMaxInstanceSize sets MaxInstanceSize field to given value. + +### HasMaxInstanceSize + +`func (o *AWSComputeAutoScaling) HasMaxInstanceSize() bool` + +HasMaxInstanceSize returns a boolean if a field has been set. + +### GetMinInstanceSize + +`func (o *AWSComputeAutoScaling) GetMinInstanceSize() string` + +GetMinInstanceSize returns the MinInstanceSize field if non-nil, zero value otherwise. + +### GetMinInstanceSizeOk + +`func (o *AWSComputeAutoScaling) GetMinInstanceSizeOk() (*string, bool)` + +GetMinInstanceSizeOk returns a tuple with the MinInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinInstanceSize + +`func (o *AWSComputeAutoScaling) SetMinInstanceSize(v string)` + +SetMinInstanceSize sets MinInstanceSize field to given value. + +### HasMinInstanceSize + +`func (o *AWSComputeAutoScaling) HasMinInstanceSize() bool` + +HasMinInstanceSize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSCustomDNSEnabled.md b/docs/docs/AWSCustomDNSEnabled.md new file mode 100644 index 00000000..1f6bde0b --- /dev/null +++ b/docs/docs/AWSCustomDNSEnabled.md @@ -0,0 +1,51 @@ +# AWSCustomDNSEnabled + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **bool** | Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS). When `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings. | + +## Methods + +### NewAWSCustomDNSEnabled + +`func NewAWSCustomDNSEnabled(enabled bool, ) *AWSCustomDNSEnabled` + +NewAWSCustomDNSEnabled instantiates a new AWSCustomDNSEnabled object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSCustomDNSEnabledWithDefaults + +`func NewAWSCustomDNSEnabledWithDefaults() *AWSCustomDNSEnabled` + +NewAWSCustomDNSEnabledWithDefaults instantiates a new AWSCustomDNSEnabled object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *AWSCustomDNSEnabled) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AWSCustomDNSEnabled) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AWSCustomDNSEnabled) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSHardwareSpec.md b/docs/docs/AWSHardwareSpec.md new file mode 100644 index 00000000..ed5b8da5 --- /dev/null +++ b/docs/docs/AWSHardwareSpec.md @@ -0,0 +1,134 @@ +# AWSHardwareSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DiskIOPS** | Pointer to **int** | Target throughput desired for storage attached to your AWS-provisioned cluster. Change this parameter only if you: - set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"AWS\"`. - set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M30\"` or greater not including `Mxx_NVME` tiers. The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. This parameter defaults to the cluster tier's standard IOPS value. Changing this value impacts cluster cost. MongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets. - Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1. - Instance sizes greater than `M40` have a ratio of 120:1. | [optional] +**EbsVolumeType** | Pointer to **string** | Type of storage you want to attach to your AWS-provisioned cluster. - `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. - `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. | [optional] [default to "STANDARD"] +**InstanceSize** | Pointer to **string** | Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. | [optional] +**NodeCount** | Pointer to **int** | Number of nodes of the given type for MongoDB Cloud to deploy to the region. | [optional] + +## Methods + +### NewAWSHardwareSpec + +`func NewAWSHardwareSpec() *AWSHardwareSpec` + +NewAWSHardwareSpec instantiates a new AWSHardwareSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSHardwareSpecWithDefaults + +`func NewAWSHardwareSpecWithDefaults() *AWSHardwareSpec` + +NewAWSHardwareSpecWithDefaults instantiates a new AWSHardwareSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDiskIOPS + +`func (o *AWSHardwareSpec) GetDiskIOPS() int` + +GetDiskIOPS returns the DiskIOPS field if non-nil, zero value otherwise. + +### GetDiskIOPSOk + +`func (o *AWSHardwareSpec) GetDiskIOPSOk() (*int, bool)` + +GetDiskIOPSOk returns a tuple with the DiskIOPS field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskIOPS + +`func (o *AWSHardwareSpec) SetDiskIOPS(v int)` + +SetDiskIOPS sets DiskIOPS field to given value. + +### HasDiskIOPS + +`func (o *AWSHardwareSpec) HasDiskIOPS() bool` + +HasDiskIOPS returns a boolean if a field has been set. + +### GetEbsVolumeType + +`func (o *AWSHardwareSpec) GetEbsVolumeType() string` + +GetEbsVolumeType returns the EbsVolumeType field if non-nil, zero value otherwise. + +### GetEbsVolumeTypeOk + +`func (o *AWSHardwareSpec) GetEbsVolumeTypeOk() (*string, bool)` + +GetEbsVolumeTypeOk returns a tuple with the EbsVolumeType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEbsVolumeType + +`func (o *AWSHardwareSpec) SetEbsVolumeType(v string)` + +SetEbsVolumeType sets EbsVolumeType field to given value. + +### HasEbsVolumeType + +`func (o *AWSHardwareSpec) HasEbsVolumeType() bool` + +HasEbsVolumeType returns a boolean if a field has been set. + +### GetInstanceSize + +`func (o *AWSHardwareSpec) GetInstanceSize() string` + +GetInstanceSize returns the InstanceSize field if non-nil, zero value otherwise. + +### GetInstanceSizeOk + +`func (o *AWSHardwareSpec) GetInstanceSizeOk() (*string, bool)` + +GetInstanceSizeOk returns a tuple with the InstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSize + +`func (o *AWSHardwareSpec) SetInstanceSize(v string)` + +SetInstanceSize sets InstanceSize field to given value. + +### HasInstanceSize + +`func (o *AWSHardwareSpec) HasInstanceSize() bool` + +HasInstanceSize returns a boolean if a field has been set. + +### GetNodeCount + +`func (o *AWSHardwareSpec) GetNodeCount() int` + +GetNodeCount returns the NodeCount field if non-nil, zero value otherwise. + +### GetNodeCountOk + +`func (o *AWSHardwareSpec) GetNodeCountOk() (*int, bool)` + +GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNodeCount + +`func (o *AWSHardwareSpec) SetNodeCount(v int)` + +SetNodeCount sets NodeCount field to given value. + +### HasNodeCount + +`func (o *AWSHardwareSpec) HasNodeCount() bool` + +HasNodeCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSInterfaceEndpoint.md b/docs/docs/AWSInterfaceEndpoint.md new file mode 100644 index 00000000..124d5458 --- /dev/null +++ b/docs/docs/AWSInterfaceEndpoint.md @@ -0,0 +1,134 @@ +# AWSInterfaceEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectionStatus** | Pointer to **string** | State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request. | [optional] [readonly] +**DeleteRequested** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**InterfaceEndpointId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the interface endpoint. | [optional] [readonly] + +## Methods + +### NewAWSInterfaceEndpoint + +`func NewAWSInterfaceEndpoint() *AWSInterfaceEndpoint` + +NewAWSInterfaceEndpoint instantiates a new AWSInterfaceEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSInterfaceEndpointWithDefaults + +`func NewAWSInterfaceEndpointWithDefaults() *AWSInterfaceEndpoint` + +NewAWSInterfaceEndpointWithDefaults instantiates a new AWSInterfaceEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetConnectionStatus + +`func (o *AWSInterfaceEndpoint) GetConnectionStatus() string` + +GetConnectionStatus returns the ConnectionStatus field if non-nil, zero value otherwise. + +### GetConnectionStatusOk + +`func (o *AWSInterfaceEndpoint) GetConnectionStatusOk() (*string, bool)` + +GetConnectionStatusOk returns a tuple with the ConnectionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionStatus + +`func (o *AWSInterfaceEndpoint) SetConnectionStatus(v string)` + +SetConnectionStatus sets ConnectionStatus field to given value. + +### HasConnectionStatus + +`func (o *AWSInterfaceEndpoint) HasConnectionStatus() bool` + +HasConnectionStatus returns a boolean if a field has been set. + +### GetDeleteRequested + +`func (o *AWSInterfaceEndpoint) GetDeleteRequested() bool` + +GetDeleteRequested returns the DeleteRequested field if non-nil, zero value otherwise. + +### GetDeleteRequestedOk + +`func (o *AWSInterfaceEndpoint) GetDeleteRequestedOk() (*bool, bool)` + +GetDeleteRequestedOk returns a tuple with the DeleteRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteRequested + +`func (o *AWSInterfaceEndpoint) SetDeleteRequested(v bool)` + +SetDeleteRequested sets DeleteRequested field to given value. + +### HasDeleteRequested + +`func (o *AWSInterfaceEndpoint) HasDeleteRequested() bool` + +HasDeleteRequested returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *AWSInterfaceEndpoint) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *AWSInterfaceEndpoint) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *AWSInterfaceEndpoint) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *AWSInterfaceEndpoint) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetInterfaceEndpointId + +`func (o *AWSInterfaceEndpoint) GetInterfaceEndpointId() string` + +GetInterfaceEndpointId returns the InterfaceEndpointId field if non-nil, zero value otherwise. + +### GetInterfaceEndpointIdOk + +`func (o *AWSInterfaceEndpoint) GetInterfaceEndpointIdOk() (*string, bool)` + +GetInterfaceEndpointIdOk returns a tuple with the InterfaceEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterfaceEndpointId + +`func (o *AWSInterfaceEndpoint) SetInterfaceEndpointId(v string)` + +SetInterfaceEndpointId sets InterfaceEndpointId field to given value. + +### HasInterfaceEndpointId + +`func (o *AWSInterfaceEndpoint) HasInterfaceEndpointId() bool` + +HasInterfaceEndpointId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSKMS.md b/docs/docs/AWSKMS.md new file mode 100644 index 00000000..f291be61 --- /dev/null +++ b/docs/docs/AWSKMS.md @@ -0,0 +1,212 @@ +# AWSKMS + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessKeyID** | Pointer to **string** | Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK). | [optional] +**CustomerMasterKeyID** | Pointer to **string** | Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys. | [optional] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`. | [optional] +**Region** | Pointer to **string** | Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. | [optional] +**RoleId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key. | [optional] +**SecretAccessKey** | Pointer to **string** | Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key. | [optional] +**Valid** | Pointer to **bool** | Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data. | [optional] [readonly] + +## Methods + +### NewAWSKMS + +`func NewAWSKMS() *AWSKMS` + +NewAWSKMS instantiates a new AWSKMS object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSKMSWithDefaults + +`func NewAWSKMSWithDefaults() *AWSKMS` + +NewAWSKMSWithDefaults instantiates a new AWSKMS object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessKeyID + +`func (o *AWSKMS) GetAccessKeyID() string` + +GetAccessKeyID returns the AccessKeyID field if non-nil, zero value otherwise. + +### GetAccessKeyIDOk + +`func (o *AWSKMS) GetAccessKeyIDOk() (*string, bool)` + +GetAccessKeyIDOk returns a tuple with the AccessKeyID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKeyID + +`func (o *AWSKMS) SetAccessKeyID(v string)` + +SetAccessKeyID sets AccessKeyID field to given value. + +### HasAccessKeyID + +`func (o *AWSKMS) HasAccessKeyID() bool` + +HasAccessKeyID returns a boolean if a field has been set. + +### GetCustomerMasterKeyID + +`func (o *AWSKMS) GetCustomerMasterKeyID() string` + +GetCustomerMasterKeyID returns the CustomerMasterKeyID field if non-nil, zero value otherwise. + +### GetCustomerMasterKeyIDOk + +`func (o *AWSKMS) GetCustomerMasterKeyIDOk() (*string, bool)` + +GetCustomerMasterKeyIDOk returns a tuple with the CustomerMasterKeyID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomerMasterKeyID + +`func (o *AWSKMS) SetCustomerMasterKeyID(v string)` + +SetCustomerMasterKeyID sets CustomerMasterKeyID field to given value. + +### HasCustomerMasterKeyID + +`func (o *AWSKMS) HasCustomerMasterKeyID() bool` + +HasCustomerMasterKeyID returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AWSKMS) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AWSKMS) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AWSKMS) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AWSKMS) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRegion + +`func (o *AWSKMS) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *AWSKMS) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *AWSKMS) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *AWSKMS) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetRoleId + +`func (o *AWSKMS) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *AWSKMS) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *AWSKMS) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *AWSKMS) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### GetSecretAccessKey + +`func (o *AWSKMS) GetSecretAccessKey() string` + +GetSecretAccessKey returns the SecretAccessKey field if non-nil, zero value otherwise. + +### GetSecretAccessKeyOk + +`func (o *AWSKMS) GetSecretAccessKeyOk() (*string, bool)` + +GetSecretAccessKeyOk returns a tuple with the SecretAccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecretAccessKey + +`func (o *AWSKMS) SetSecretAccessKey(v string)` + +SetSecretAccessKey sets SecretAccessKey field to given value. + +### HasSecretAccessKey + +`func (o *AWSKMS) HasSecretAccessKey() bool` + +HasSecretAccessKey returns a boolean if a field has been set. + +### GetValid + +`func (o *AWSKMS) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *AWSKMS) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *AWSKMS) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *AWSKMS) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSPeerVpc.md b/docs/docs/AWSPeerVpc.md new file mode 100644 index 00000000..9cb1c346 --- /dev/null +++ b/docs/docs/AWSPeerVpc.md @@ -0,0 +1,265 @@ +# AWSPeerVpc + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccepterRegionName** | **string** | Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region. | +**AwsAccountId** | **string** | Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. | +**ConnectionId** | Pointer to **string** | Unique string that identifies the peering connection on AWS. | [optional] [readonly] +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ErrorStateName** | Pointer to **string** | Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering connection. | [optional] +**RouteTableCidrBlock** | **string** | Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. | +**StatusName** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VpcId** | **string** | Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. | + +## Methods + +### NewAWSPeerVpc + +`func NewAWSPeerVpc(accepterRegionName string, awsAccountId string, containerId string, routeTableCidrBlock string, vpcId string, ) *AWSPeerVpc` + +NewAWSPeerVpc instantiates a new AWSPeerVpc object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSPeerVpcWithDefaults + +`func NewAWSPeerVpcWithDefaults() *AWSPeerVpc` + +NewAWSPeerVpcWithDefaults instantiates a new AWSPeerVpc object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccepterRegionName + +`func (o *AWSPeerVpc) GetAccepterRegionName() string` + +GetAccepterRegionName returns the AccepterRegionName field if non-nil, zero value otherwise. + +### GetAccepterRegionNameOk + +`func (o *AWSPeerVpc) GetAccepterRegionNameOk() (*string, bool)` + +GetAccepterRegionNameOk returns a tuple with the AccepterRegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccepterRegionName + +`func (o *AWSPeerVpc) SetAccepterRegionName(v string)` + +SetAccepterRegionName sets AccepterRegionName field to given value. + + +### GetAwsAccountId + +`func (o *AWSPeerVpc) GetAwsAccountId() string` + +GetAwsAccountId returns the AwsAccountId field if non-nil, zero value otherwise. + +### GetAwsAccountIdOk + +`func (o *AWSPeerVpc) GetAwsAccountIdOk() (*string, bool)` + +GetAwsAccountIdOk returns a tuple with the AwsAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccountId + +`func (o *AWSPeerVpc) SetAwsAccountId(v string)` + +SetAwsAccountId sets AwsAccountId field to given value. + + +### GetConnectionId + +`func (o *AWSPeerVpc) GetConnectionId() string` + +GetConnectionId returns the ConnectionId field if non-nil, zero value otherwise. + +### GetConnectionIdOk + +`func (o *AWSPeerVpc) GetConnectionIdOk() (*string, bool)` + +GetConnectionIdOk returns a tuple with the ConnectionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionId + +`func (o *AWSPeerVpc) SetConnectionId(v string)` + +SetConnectionId sets ConnectionId field to given value. + +### HasConnectionId + +`func (o *AWSPeerVpc) HasConnectionId() bool` + +HasConnectionId returns a boolean if a field has been set. + +### GetContainerId + +`func (o *AWSPeerVpc) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *AWSPeerVpc) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *AWSPeerVpc) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetErrorStateName + +`func (o *AWSPeerVpc) GetErrorStateName() string` + +GetErrorStateName returns the ErrorStateName field if non-nil, zero value otherwise. + +### GetErrorStateNameOk + +`func (o *AWSPeerVpc) GetErrorStateNameOk() (*string, bool)` + +GetErrorStateNameOk returns a tuple with the ErrorStateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorStateName + +`func (o *AWSPeerVpc) SetErrorStateName(v string)` + +SetErrorStateName sets ErrorStateName field to given value. + +### HasErrorStateName + +`func (o *AWSPeerVpc) HasErrorStateName() bool` + +HasErrorStateName returns a boolean if a field has been set. + +### GetId + +`func (o *AWSPeerVpc) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AWSPeerVpc) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AWSPeerVpc) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AWSPeerVpc) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AWSPeerVpc) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AWSPeerVpc) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AWSPeerVpc) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *AWSPeerVpc) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRouteTableCidrBlock + +`func (o *AWSPeerVpc) GetRouteTableCidrBlock() string` + +GetRouteTableCidrBlock returns the RouteTableCidrBlock field if non-nil, zero value otherwise. + +### GetRouteTableCidrBlockOk + +`func (o *AWSPeerVpc) GetRouteTableCidrBlockOk() (*string, bool)` + +GetRouteTableCidrBlockOk returns a tuple with the RouteTableCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRouteTableCidrBlock + +`func (o *AWSPeerVpc) SetRouteTableCidrBlock(v string)` + +SetRouteTableCidrBlock sets RouteTableCidrBlock field to given value. + + +### GetStatusName + +`func (o *AWSPeerVpc) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *AWSPeerVpc) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *AWSPeerVpc) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *AWSPeerVpc) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetVpcId + +`func (o *AWSPeerVpc) GetVpcId() string` + +GetVpcId returns the VpcId field if non-nil, zero value otherwise. + +### GetVpcIdOk + +`func (o *AWSPeerVpc) GetVpcIdOk() (*string, bool)` + +GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVpcId + +`func (o *AWSPeerVpc) SetVpcId(v string)` + +SetVpcId sets VpcId field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSPeerVpcRequest.md b/docs/docs/AWSPeerVpcRequest.md new file mode 100644 index 00000000..be45e9e1 --- /dev/null +++ b/docs/docs/AWSPeerVpcRequest.md @@ -0,0 +1,260 @@ +# AWSPeerVpcRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ProviderName** | **string** | Cloud service provider that serves the requested network peering connection. | +**AccepterRegionName** | **string** | Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region. | +**AwsAccountId** | **string** | Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. | +**ConnectionId** | Pointer to **string** | Unique string that identifies the peering connection on AWS. | [optional] [readonly] +**ErrorStateName** | Pointer to **string** | Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**RouteTableCidrBlock** | **string** | Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. | +**StatusName** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VpcId** | **string** | Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. | + +## Methods + +### NewAWSPeerVpcRequest + +`func NewAWSPeerVpcRequest(containerId string, providerName string, accepterRegionName string, awsAccountId string, routeTableCidrBlock string, vpcId string, ) *AWSPeerVpcRequest` + +NewAWSPeerVpcRequest instantiates a new AWSPeerVpcRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSPeerVpcRequestWithDefaults + +`func NewAWSPeerVpcRequestWithDefaults() *AWSPeerVpcRequest` + +NewAWSPeerVpcRequestWithDefaults instantiates a new AWSPeerVpcRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContainerId + +`func (o *AWSPeerVpcRequest) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *AWSPeerVpcRequest) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *AWSPeerVpcRequest) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetProviderName + +`func (o *AWSPeerVpcRequest) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AWSPeerVpcRequest) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AWSPeerVpcRequest) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetAccepterRegionName + +`func (o *AWSPeerVpcRequest) GetAccepterRegionName() string` + +GetAccepterRegionName returns the AccepterRegionName field if non-nil, zero value otherwise. + +### GetAccepterRegionNameOk + +`func (o *AWSPeerVpcRequest) GetAccepterRegionNameOk() (*string, bool)` + +GetAccepterRegionNameOk returns a tuple with the AccepterRegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccepterRegionName + +`func (o *AWSPeerVpcRequest) SetAccepterRegionName(v string)` + +SetAccepterRegionName sets AccepterRegionName field to given value. + + +### GetAwsAccountId + +`func (o *AWSPeerVpcRequest) GetAwsAccountId() string` + +GetAwsAccountId returns the AwsAccountId field if non-nil, zero value otherwise. + +### GetAwsAccountIdOk + +`func (o *AWSPeerVpcRequest) GetAwsAccountIdOk() (*string, bool)` + +GetAwsAccountIdOk returns a tuple with the AwsAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccountId + +`func (o *AWSPeerVpcRequest) SetAwsAccountId(v string)` + +SetAwsAccountId sets AwsAccountId field to given value. + + +### GetConnectionId + +`func (o *AWSPeerVpcRequest) GetConnectionId() string` + +GetConnectionId returns the ConnectionId field if non-nil, zero value otherwise. + +### GetConnectionIdOk + +`func (o *AWSPeerVpcRequest) GetConnectionIdOk() (*string, bool)` + +GetConnectionIdOk returns a tuple with the ConnectionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionId + +`func (o *AWSPeerVpcRequest) SetConnectionId(v string)` + +SetConnectionId sets ConnectionId field to given value. + +### HasConnectionId + +`func (o *AWSPeerVpcRequest) HasConnectionId() bool` + +HasConnectionId returns a boolean if a field has been set. + +### GetErrorStateName + +`func (o *AWSPeerVpcRequest) GetErrorStateName() string` + +GetErrorStateName returns the ErrorStateName field if non-nil, zero value otherwise. + +### GetErrorStateNameOk + +`func (o *AWSPeerVpcRequest) GetErrorStateNameOk() (*string, bool)` + +GetErrorStateNameOk returns a tuple with the ErrorStateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorStateName + +`func (o *AWSPeerVpcRequest) SetErrorStateName(v string)` + +SetErrorStateName sets ErrorStateName field to given value. + +### HasErrorStateName + +`func (o *AWSPeerVpcRequest) HasErrorStateName() bool` + +HasErrorStateName returns a boolean if a field has been set. + +### GetId + +`func (o *AWSPeerVpcRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AWSPeerVpcRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AWSPeerVpcRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AWSPeerVpcRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRouteTableCidrBlock + +`func (o *AWSPeerVpcRequest) GetRouteTableCidrBlock() string` + +GetRouteTableCidrBlock returns the RouteTableCidrBlock field if non-nil, zero value otherwise. + +### GetRouteTableCidrBlockOk + +`func (o *AWSPeerVpcRequest) GetRouteTableCidrBlockOk() (*string, bool)` + +GetRouteTableCidrBlockOk returns a tuple with the RouteTableCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRouteTableCidrBlock + +`func (o *AWSPeerVpcRequest) SetRouteTableCidrBlock(v string)` + +SetRouteTableCidrBlock sets RouteTableCidrBlock field to given value. + + +### GetStatusName + +`func (o *AWSPeerVpcRequest) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *AWSPeerVpcRequest) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *AWSPeerVpcRequest) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *AWSPeerVpcRequest) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetVpcId + +`func (o *AWSPeerVpcRequest) GetVpcId() string` + +GetVpcId returns the VpcId field if non-nil, zero value otherwise. + +### GetVpcIdOk + +`func (o *AWSPeerVpcRequest) GetVpcIdOk() (*string, bool)` + +GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVpcId + +`func (o *AWSPeerVpcRequest) SetVpcId(v string)` + +SetVpcId sets VpcId field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSPrivateLinkConnection.md b/docs/docs/AWSPrivateLinkConnection.md new file mode 100644 index 00000000..d046919f --- /dev/null +++ b/docs/docs/AWSPrivateLinkConnection.md @@ -0,0 +1,186 @@ +# AWSPrivateLinkConnection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointServiceName** | Pointer to **string** | Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. | [optional] [readonly] +**InterfaceEndpoints** | Pointer to **[]string** | List of strings that identify private endpoint interfaces applied to the specified project. | [optional] [readonly] +**RegionName** | Pointer to **string** | Cloud provider region that manages this Private Endpoint Service. | [optional] [readonly] +**Status** | Pointer to **string** | State of the Private Endpoint Service connection when MongoDB Cloud received this request. | [optional] [readonly] + +## Methods + +### NewAWSPrivateLinkConnection + +`func NewAWSPrivateLinkConnection() *AWSPrivateLinkConnection` + +NewAWSPrivateLinkConnection instantiates a new AWSPrivateLinkConnection object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSPrivateLinkConnectionWithDefaults + +`func NewAWSPrivateLinkConnectionWithDefaults() *AWSPrivateLinkConnection` + +NewAWSPrivateLinkConnectionWithDefaults instantiates a new AWSPrivateLinkConnection object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointServiceName + +`func (o *AWSPrivateLinkConnection) GetEndpointServiceName() string` + +GetEndpointServiceName returns the EndpointServiceName field if non-nil, zero value otherwise. + +### GetEndpointServiceNameOk + +`func (o *AWSPrivateLinkConnection) GetEndpointServiceNameOk() (*string, bool)` + +GetEndpointServiceNameOk returns a tuple with the EndpointServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointServiceName + +`func (o *AWSPrivateLinkConnection) SetEndpointServiceName(v string)` + +SetEndpointServiceName sets EndpointServiceName field to given value. + +### HasEndpointServiceName + +`func (o *AWSPrivateLinkConnection) HasEndpointServiceName() bool` + +HasEndpointServiceName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *AWSPrivateLinkConnection) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *AWSPrivateLinkConnection) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *AWSPrivateLinkConnection) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *AWSPrivateLinkConnection) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetId + +`func (o *AWSPrivateLinkConnection) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AWSPrivateLinkConnection) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AWSPrivateLinkConnection) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AWSPrivateLinkConnection) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetInterfaceEndpoints + +`func (o *AWSPrivateLinkConnection) GetInterfaceEndpoints() []string` + +GetInterfaceEndpoints returns the InterfaceEndpoints field if non-nil, zero value otherwise. + +### GetInterfaceEndpointsOk + +`func (o *AWSPrivateLinkConnection) GetInterfaceEndpointsOk() (*[]string, bool)` + +GetInterfaceEndpointsOk returns a tuple with the InterfaceEndpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterfaceEndpoints + +`func (o *AWSPrivateLinkConnection) SetInterfaceEndpoints(v []string)` + +SetInterfaceEndpoints sets InterfaceEndpoints field to given value. + +### HasInterfaceEndpoints + +`func (o *AWSPrivateLinkConnection) HasInterfaceEndpoints() bool` + +HasInterfaceEndpoints returns a boolean if a field has been set. + +### GetRegionName + +`func (o *AWSPrivateLinkConnection) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *AWSPrivateLinkConnection) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *AWSPrivateLinkConnection) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *AWSPrivateLinkConnection) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AWSPrivateLinkConnection) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AWSPrivateLinkConnection) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AWSPrivateLinkConnection) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AWSPrivateLinkConnection) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSProviderSettings.md b/docs/docs/AWSProviderSettings.md new file mode 100644 index 00000000..581b9b6f --- /dev/null +++ b/docs/docs/AWSProviderSettings.md @@ -0,0 +1,207 @@ +# AWSProviderSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoScaling** | Pointer to [**AWSAutoScaling**](AWSAutoScaling.md) | | [optional] +**DiskIOPS** | Pointer to **int** | Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform. | [optional] +**EncryptEBSVolume** | Pointer to **bool** | Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled. | [optional] [default to true] +**InstanceSizeName** | Pointer to **string** | Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. | [optional] +**RegionName** | Pointer to **string** | Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. | [optional] +**VolumeType** | Pointer to **string** | Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS</abbr>. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). | [optional] +**ProviderName** | **string** | | + +## Methods + +### NewAWSProviderSettings + +`func NewAWSProviderSettings(providerName string, ) *AWSProviderSettings` + +NewAWSProviderSettings instantiates a new AWSProviderSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSProviderSettingsWithDefaults + +`func NewAWSProviderSettingsWithDefaults() *AWSProviderSettings` + +NewAWSProviderSettingsWithDefaults instantiates a new AWSProviderSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoScaling + +`func (o *AWSProviderSettings) GetAutoScaling() AWSAutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *AWSProviderSettings) GetAutoScalingOk() (*AWSAutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *AWSProviderSettings) SetAutoScaling(v AWSAutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *AWSProviderSettings) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetDiskIOPS + +`func (o *AWSProviderSettings) GetDiskIOPS() int` + +GetDiskIOPS returns the DiskIOPS field if non-nil, zero value otherwise. + +### GetDiskIOPSOk + +`func (o *AWSProviderSettings) GetDiskIOPSOk() (*int, bool)` + +GetDiskIOPSOk returns a tuple with the DiskIOPS field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskIOPS + +`func (o *AWSProviderSettings) SetDiskIOPS(v int)` + +SetDiskIOPS sets DiskIOPS field to given value. + +### HasDiskIOPS + +`func (o *AWSProviderSettings) HasDiskIOPS() bool` + +HasDiskIOPS returns a boolean if a field has been set. + +### GetEncryptEBSVolume + +`func (o *AWSProviderSettings) GetEncryptEBSVolume() bool` + +GetEncryptEBSVolume returns the EncryptEBSVolume field if non-nil, zero value otherwise. + +### GetEncryptEBSVolumeOk + +`func (o *AWSProviderSettings) GetEncryptEBSVolumeOk() (*bool, bool)` + +GetEncryptEBSVolumeOk returns a tuple with the EncryptEBSVolume field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptEBSVolume + +`func (o *AWSProviderSettings) SetEncryptEBSVolume(v bool)` + +SetEncryptEBSVolume sets EncryptEBSVolume field to given value. + +### HasEncryptEBSVolume + +`func (o *AWSProviderSettings) HasEncryptEBSVolume() bool` + +HasEncryptEBSVolume returns a boolean if a field has been set. + +### GetInstanceSizeName + +`func (o *AWSProviderSettings) GetInstanceSizeName() string` + +GetInstanceSizeName returns the InstanceSizeName field if non-nil, zero value otherwise. + +### GetInstanceSizeNameOk + +`func (o *AWSProviderSettings) GetInstanceSizeNameOk() (*string, bool)` + +GetInstanceSizeNameOk returns a tuple with the InstanceSizeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSizeName + +`func (o *AWSProviderSettings) SetInstanceSizeName(v string)` + +SetInstanceSizeName sets InstanceSizeName field to given value. + +### HasInstanceSizeName + +`func (o *AWSProviderSettings) HasInstanceSizeName() bool` + +HasInstanceSizeName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *AWSProviderSettings) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *AWSProviderSettings) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *AWSProviderSettings) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *AWSProviderSettings) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetVolumeType + +`func (o *AWSProviderSettings) GetVolumeType() string` + +GetVolumeType returns the VolumeType field if non-nil, zero value otherwise. + +### GetVolumeTypeOk + +`func (o *AWSProviderSettings) GetVolumeTypeOk() (*string, bool)` + +GetVolumeTypeOk returns a tuple with the VolumeType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVolumeType + +`func (o *AWSProviderSettings) SetVolumeType(v string)` + +SetVolumeType sets VolumeType field to given value. + +### HasVolumeType + +`func (o *AWSProviderSettings) HasVolumeType() bool` + +HasVolumeType returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AWSProviderSettings) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AWSProviderSettings) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AWSProviderSettings) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AWSRegionConfig.md b/docs/docs/AWSRegionConfig.md new file mode 100644 index 00000000..907abc4e --- /dev/null +++ b/docs/docs/AWSRegionConfig.md @@ -0,0 +1,238 @@ +# AWSRegionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AnalyticsAutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**AnalyticsSpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**AutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**ReadOnlySpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**ElectableSpecs** | Pointer to [**HardwareSpec**](HardwareSpec.md) | | [optional] +**Priority** | Pointer to **int** | Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`. **Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively. | [optional] +**ProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`. | [optional] +**RegionName** | Pointer to **string** | Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. | [optional] + +## Methods + +### NewAWSRegionConfig + +`func NewAWSRegionConfig() *AWSRegionConfig` + +NewAWSRegionConfig instantiates a new AWSRegionConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAWSRegionConfigWithDefaults + +`func NewAWSRegionConfigWithDefaults() *AWSRegionConfig` + +NewAWSRegionConfigWithDefaults instantiates a new AWSRegionConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAnalyticsAutoScaling + +`func (o *AWSRegionConfig) GetAnalyticsAutoScaling() AutoScalingV15` + +GetAnalyticsAutoScaling returns the AnalyticsAutoScaling field if non-nil, zero value otherwise. + +### GetAnalyticsAutoScalingOk + +`func (o *AWSRegionConfig) GetAnalyticsAutoScalingOk() (*AutoScalingV15, bool)` + +GetAnalyticsAutoScalingOk returns a tuple with the AnalyticsAutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsAutoScaling + +`func (o *AWSRegionConfig) SetAnalyticsAutoScaling(v AutoScalingV15)` + +SetAnalyticsAutoScaling sets AnalyticsAutoScaling field to given value. + +### HasAnalyticsAutoScaling + +`func (o *AWSRegionConfig) HasAnalyticsAutoScaling() bool` + +HasAnalyticsAutoScaling returns a boolean if a field has been set. + +### GetAnalyticsSpecs + +`func (o *AWSRegionConfig) GetAnalyticsSpecs() DedicatedHardwareSpec` + +GetAnalyticsSpecs returns the AnalyticsSpecs field if non-nil, zero value otherwise. + +### GetAnalyticsSpecsOk + +`func (o *AWSRegionConfig) GetAnalyticsSpecsOk() (*DedicatedHardwareSpec, bool)` + +GetAnalyticsSpecsOk returns a tuple with the AnalyticsSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsSpecs + +`func (o *AWSRegionConfig) SetAnalyticsSpecs(v DedicatedHardwareSpec)` + +SetAnalyticsSpecs sets AnalyticsSpecs field to given value. + +### HasAnalyticsSpecs + +`func (o *AWSRegionConfig) HasAnalyticsSpecs() bool` + +HasAnalyticsSpecs returns a boolean if a field has been set. + +### GetAutoScaling + +`func (o *AWSRegionConfig) GetAutoScaling() AutoScalingV15` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *AWSRegionConfig) GetAutoScalingOk() (*AutoScalingV15, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *AWSRegionConfig) SetAutoScaling(v AutoScalingV15)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *AWSRegionConfig) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetReadOnlySpecs + +`func (o *AWSRegionConfig) GetReadOnlySpecs() DedicatedHardwareSpec` + +GetReadOnlySpecs returns the ReadOnlySpecs field if non-nil, zero value otherwise. + +### GetReadOnlySpecsOk + +`func (o *AWSRegionConfig) GetReadOnlySpecsOk() (*DedicatedHardwareSpec, bool)` + +GetReadOnlySpecsOk returns a tuple with the ReadOnlySpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadOnlySpecs + +`func (o *AWSRegionConfig) SetReadOnlySpecs(v DedicatedHardwareSpec)` + +SetReadOnlySpecs sets ReadOnlySpecs field to given value. + +### HasReadOnlySpecs + +`func (o *AWSRegionConfig) HasReadOnlySpecs() bool` + +HasReadOnlySpecs returns a boolean if a field has been set. + +### GetElectableSpecs + +`func (o *AWSRegionConfig) GetElectableSpecs() HardwareSpec` + +GetElectableSpecs returns the ElectableSpecs field if non-nil, zero value otherwise. + +### GetElectableSpecsOk + +`func (o *AWSRegionConfig) GetElectableSpecsOk() (*HardwareSpec, bool)` + +GetElectableSpecsOk returns a tuple with the ElectableSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElectableSpecs + +`func (o *AWSRegionConfig) SetElectableSpecs(v HardwareSpec)` + +SetElectableSpecs sets ElectableSpecs field to given value. + +### HasElectableSpecs + +`func (o *AWSRegionConfig) HasElectableSpecs() bool` + +HasElectableSpecs returns a boolean if a field has been set. + +### GetPriority + +`func (o *AWSRegionConfig) GetPriority() int` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *AWSRegionConfig) GetPriorityOk() (*int, bool)` + +GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPriority + +`func (o *AWSRegionConfig) SetPriority(v int)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *AWSRegionConfig) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AWSRegionConfig) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AWSRegionConfig) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AWSRegionConfig) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *AWSRegionConfig) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *AWSRegionConfig) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *AWSRegionConfig) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *AWSRegionConfig) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *AWSRegionConfig) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AccessListItem.md b/docs/docs/AccessListItem.md new file mode 100644 index 00000000..a04a9b45 --- /dev/null +++ b/docs/docs/AccessListItem.md @@ -0,0 +1,77 @@ +# AccessListItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CidrBlock** | Pointer to **string** | Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list. | [optional] [readonly] +**IpAddress** | **string** | IP address included in the API access list. | [readonly] + +## Methods + +### NewAccessListItem + +`func NewAccessListItem(ipAddress string, ) *AccessListItem` + +NewAccessListItem instantiates a new AccessListItem object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAccessListItemWithDefaults + +`func NewAccessListItemWithDefaults() *AccessListItem` + +NewAccessListItemWithDefaults instantiates a new AccessListItem object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCidrBlock + +`func (o *AccessListItem) GetCidrBlock() string` + +GetCidrBlock returns the CidrBlock field if non-nil, zero value otherwise. + +### GetCidrBlockOk + +`func (o *AccessListItem) GetCidrBlockOk() (*string, bool)` + +GetCidrBlockOk returns a tuple with the CidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidrBlock + +`func (o *AccessListItem) SetCidrBlock(v string)` + +SetCidrBlock sets CidrBlock field to given value. + +### HasCidrBlock + +`func (o *AccessListItem) HasCidrBlock() bool` + +HasCidrBlock returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *AccessListItem) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *AccessListItem) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *AccessListItem) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AccessTrackingApi.md b/docs/docs/AccessTrackingApi.md index 7552c813..ea3f0f49 100644 --- a/docs/docs/AccessTrackingApi.md +++ b/docs/docs/AccessTrackingApi.md @@ -84,7 +84,7 @@ Name | Type | Description | Notes [**MongoDBAccessLogsList**](MongoDBAccessLogsList.md) ### Authorization -[DigestAuth](../../README.md) +[DigestAuth](../README.md#Authentication) ### HTTP request headers @@ -171,7 +171,7 @@ Name | Type | Description | Notes [**MongoDBAccessLogsList**](MongoDBAccessLogsList.md) ### Authorization -[DigestAuth](../../README.md) +[DigestAuth](../README.md#Authentication) ### HTTP request headers diff --git a/docs/docs/AddUserToTeam.md b/docs/docs/AddUserToTeam.md new file mode 100644 index 00000000..8cff5102 --- /dev/null +++ b/docs/docs/AddUserToTeam.md @@ -0,0 +1,51 @@ +# AddUserToTeam + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user. | + +## Methods + +### NewAddUserToTeam + +`func NewAddUserToTeam(id string, ) *AddUserToTeam` + +NewAddUserToTeam instantiates a new AddUserToTeam object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAddUserToTeamWithDefaults + +`func NewAddUserToTeamWithDefaults() *AddUserToTeam` + +NewAddUserToTeamWithDefaults instantiates a new AddUserToTeam object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *AddUserToTeam) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AddUserToTeam) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AddUserToTeam) SetId(v string)` + +SetId sets Id field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Alert.md b/docs/docs/Alert.md new file mode 100644 index 00000000..2766f091 --- /dev/null +++ b/docs/docs/Alert.md @@ -0,0 +1,338 @@ +# Alert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewAlert + +`func NewAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, id string, status string, updated time.Time, ) *Alert` + +NewAlert instantiates a new Alert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAlertWithDefaults + +`func NewAlertWithDefaults() *Alert` + +NewAlertWithDefaults instantiates a new Alert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *Alert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *Alert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *Alert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *Alert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *Alert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *Alert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *Alert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *Alert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *Alert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *Alert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *Alert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *Alert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *Alert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *Alert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetCreated + +`func (o *Alert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Alert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Alert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetGroupId + +`func (o *Alert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *Alert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *Alert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *Alert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *Alert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Alert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Alert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *Alert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *Alert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *Alert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *Alert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *Alert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Alert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Alert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Alert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *Alert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *Alert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *Alert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *Alert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetResolved + +`func (o *Alert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *Alert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *Alert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *Alert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *Alert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Alert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Alert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *Alert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *Alert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *Alert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertAudit.md b/docs/docs/AlertAudit.md new file mode 100644 index 00000000..98c5256a --- /dev/null +++ b/docs/docs/AlertAudit.md @@ -0,0 +1,379 @@ +# AlertAudit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlertId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert associated with the event. | [optional] [readonly] +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**AlertAuditType**](AlertAuditType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewAlertAudit + +`func NewAlertAudit(created time.Time, eventTypeName AlertAuditType, id string, ) *AlertAudit` + +NewAlertAudit instantiates a new AlertAudit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAlertAuditWithDefaults + +`func NewAlertAuditWithDefaults() *AlertAudit` + +NewAlertAuditWithDefaults instantiates a new AlertAudit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAlertId + +`func (o *AlertAudit) GetAlertId() string` + +GetAlertId returns the AlertId field if non-nil, zero value otherwise. + +### GetAlertIdOk + +`func (o *AlertAudit) GetAlertIdOk() (*string, bool)` + +GetAlertIdOk returns a tuple with the AlertId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertId + +`func (o *AlertAudit) SetAlertId(v string)` + +SetAlertId sets AlertId field to given value. + +### HasAlertId + +`func (o *AlertAudit) HasAlertId() bool` + +HasAlertId returns a boolean if a field has been set. + +### GetApiKeyId + +`func (o *AlertAudit) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *AlertAudit) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *AlertAudit) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *AlertAudit) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *AlertAudit) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AlertAudit) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AlertAudit) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *AlertAudit) GetEventTypeName() AlertAuditType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AlertAudit) GetEventTypeNameOk() (*AlertAuditType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AlertAudit) SetEventTypeName(v AlertAuditType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *AlertAudit) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AlertAudit) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AlertAudit) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AlertAudit) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AlertAudit) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AlertAudit) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AlertAudit) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *AlertAudit) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *AlertAudit) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *AlertAudit) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *AlertAudit) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *AlertAudit) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AlertAudit) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AlertAudit) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AlertAudit) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *AlertAudit) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *AlertAudit) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *AlertAudit) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *AlertAudit) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *AlertAudit) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *AlertAudit) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *AlertAudit) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *AlertAudit) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *AlertAudit) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *AlertAudit) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *AlertAudit) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *AlertAudit) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *AlertAudit) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *AlertAudit) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *AlertAudit) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *AlertAudit) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *AlertAudit) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *AlertAudit) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *AlertAudit) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *AlertAudit) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *AlertAudit) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *AlertAudit) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *AlertAudit) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *AlertAudit) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertAuditType.md b/docs/docs/AlertAuditType.md new file mode 100644 index 00000000..4559d5c5 --- /dev/null +++ b/docs/docs/AlertAuditType.md @@ -0,0 +1,13 @@ +# AlertAuditType + +## Enum + + +* `ACKNOWLEDGED_AUDIT` (value: `"ALERT_ACKNOWLEDGED_AUDIT"`) + +* `UNACKNOWLEDGED_AUDIT` (value: `"ALERT_UNACKNOWLEDGED_AUDIT"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertConfig.md b/docs/docs/AlertConfig.md new file mode 100644 index 00000000..97b36072 --- /dev/null +++ b/docs/docs/AlertConfig.md @@ -0,0 +1,264 @@ +# AlertConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | Pointer to **string** | | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**Notifications** | Pointer to [**[]Notification**](Notification.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewAlertConfig + +`func NewAlertConfig() *AlertConfig` + +NewAlertConfig instantiates a new AlertConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAlertConfigWithDefaults + +`func NewAlertConfigWithDefaults() *AlertConfig` + +NewAlertConfigWithDefaults instantiates a new AlertConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *AlertConfig) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AlertConfig) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AlertConfig) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AlertConfig) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AlertConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AlertConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AlertConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AlertConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *AlertConfig) GetEventTypeName() string` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AlertConfig) GetEventTypeNameOk() (*string, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AlertConfig) SetEventTypeName(v string)` + +SetEventTypeName sets EventTypeName field to given value. + +### HasEventTypeName + +`func (o *AlertConfig) HasEventTypeName() bool` + +HasEventTypeName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *AlertConfig) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AlertConfig) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AlertConfig) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AlertConfig) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AlertConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AlertConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AlertConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AlertConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *AlertConfig) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AlertConfig) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AlertConfig) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AlertConfig) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *AlertConfig) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *AlertConfig) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *AlertConfig) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *AlertConfig) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *AlertConfig) GetNotifications() []Notification` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *AlertConfig) GetNotificationsOk() (*[]Notification, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *AlertConfig) SetNotifications(v []Notification)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *AlertConfig) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *AlertConfig) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *AlertConfig) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *AlertConfig) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *AlertConfig) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertConfigAudit.md b/docs/docs/AlertConfigAudit.md new file mode 100644 index 00000000..def0d326 --- /dev/null +++ b/docs/docs/AlertConfigAudit.md @@ -0,0 +1,379 @@ +# AlertConfigAudit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlertConfigId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**. | [optional] [readonly] +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**AlertConfigAuditType**](AlertConfigAuditType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewAlertConfigAudit + +`func NewAlertConfigAudit(created time.Time, eventTypeName AlertConfigAuditType, id string, ) *AlertConfigAudit` + +NewAlertConfigAudit instantiates a new AlertConfigAudit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAlertConfigAuditWithDefaults + +`func NewAlertConfigAuditWithDefaults() *AlertConfigAudit` + +NewAlertConfigAuditWithDefaults instantiates a new AlertConfigAudit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAlertConfigId + +`func (o *AlertConfigAudit) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *AlertConfigAudit) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *AlertConfigAudit) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + +### HasAlertConfigId + +`func (o *AlertConfigAudit) HasAlertConfigId() bool` + +HasAlertConfigId returns a boolean if a field has been set. + +### GetApiKeyId + +`func (o *AlertConfigAudit) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *AlertConfigAudit) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *AlertConfigAudit) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *AlertConfigAudit) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *AlertConfigAudit) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AlertConfigAudit) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AlertConfigAudit) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *AlertConfigAudit) GetEventTypeName() AlertConfigAuditType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AlertConfigAudit) GetEventTypeNameOk() (*AlertConfigAuditType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AlertConfigAudit) SetEventTypeName(v AlertConfigAuditType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *AlertConfigAudit) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AlertConfigAudit) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AlertConfigAudit) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AlertConfigAudit) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AlertConfigAudit) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AlertConfigAudit) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AlertConfigAudit) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *AlertConfigAudit) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *AlertConfigAudit) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *AlertConfigAudit) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *AlertConfigAudit) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *AlertConfigAudit) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AlertConfigAudit) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AlertConfigAudit) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AlertConfigAudit) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *AlertConfigAudit) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *AlertConfigAudit) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *AlertConfigAudit) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *AlertConfigAudit) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *AlertConfigAudit) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *AlertConfigAudit) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *AlertConfigAudit) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *AlertConfigAudit) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *AlertConfigAudit) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *AlertConfigAudit) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *AlertConfigAudit) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *AlertConfigAudit) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *AlertConfigAudit) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *AlertConfigAudit) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *AlertConfigAudit) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *AlertConfigAudit) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *AlertConfigAudit) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *AlertConfigAudit) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *AlertConfigAudit) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *AlertConfigAudit) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *AlertConfigAudit) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *AlertConfigAudit) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *AlertConfigAudit) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *AlertConfigAudit) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertConfigAuditType.md b/docs/docs/AlertConfigAuditType.md new file mode 100644 index 00000000..8f242925 --- /dev/null +++ b/docs/docs/AlertConfigAuditType.md @@ -0,0 +1,19 @@ +# AlertConfigAuditType + +## Enum + + +* `DISABLED_AUDIT` (value: `"ALERT_CONFIG_DISABLED_AUDIT"`) + +* `ENABLED_AUDIT` (value: `"ALERT_CONFIG_ENABLED_AUDIT"`) + +* `ADDED_AUDIT` (value: `"ALERT_CONFIG_ADDED_AUDIT"`) + +* `DELETED_AUDIT` (value: `"ALERT_CONFIG_DELETED_AUDIT"`) + +* `CHANGED_AUDIT` (value: `"ALERT_CONFIG_CHANGED_AUDIT"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertConfigViewForNdsGroup.md b/docs/docs/AlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..4b725b85 --- /dev/null +++ b/docs/docs/AlertConfigViewForNdsGroup.md @@ -0,0 +1,316 @@ +# AlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | Pointer to [**ServerlessEventTypeViewAlertable**](ServerlessEventTypeViewAlertable.md) | | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**MetricThreshold** | Pointer to [**ServerlessMetricThreshold**](ServerlessMetricThreshold.md) | | [optional] +**Threshold** | Pointer to [**ThresholdViewInteger**](ThresholdViewInteger.md) | | [optional] + +## Methods + +### NewAlertConfigViewForNdsGroup + +`func NewAlertConfigViewForNdsGroup() *AlertConfigViewForNdsGroup` + +NewAlertConfigViewForNdsGroup instantiates a new AlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAlertConfigViewForNdsGroupWithDefaults + +`func NewAlertConfigViewForNdsGroupWithDefaults() *AlertConfigViewForNdsGroup` + +NewAlertConfigViewForNdsGroupWithDefaults instantiates a new AlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *AlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *AlertConfigViewForNdsGroup) GetEventTypeName() ServerlessEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AlertConfigViewForNdsGroup) GetEventTypeNameOk() (*ServerlessEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AlertConfigViewForNdsGroup) SetEventTypeName(v ServerlessEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + +### HasEventTypeName + +`func (o *AlertConfigViewForNdsGroup) HasEventTypeName() bool` + +HasEventTypeName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *AlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *AlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *AlertConfigViewForNdsGroup) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *AlertConfigViewForNdsGroup) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *AlertConfigViewForNdsGroup) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *AlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *AlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *AlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *AlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *AlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *AlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *AlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *AlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *AlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + +### GetMetricThreshold + +`func (o *AlertConfigViewForNdsGroup) GetMetricThreshold() ServerlessMetricThreshold` + +GetMetricThreshold returns the MetricThreshold field if non-nil, zero value otherwise. + +### GetMetricThresholdOk + +`func (o *AlertConfigViewForNdsGroup) GetMetricThresholdOk() (*ServerlessMetricThreshold, bool)` + +GetMetricThresholdOk returns a tuple with the MetricThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricThreshold + +`func (o *AlertConfigViewForNdsGroup) SetMetricThreshold(v ServerlessMetricThreshold)` + +SetMetricThreshold sets MetricThreshold field to given value. + +### HasMetricThreshold + +`func (o *AlertConfigViewForNdsGroup) HasMetricThreshold() bool` + +HasMetricThreshold returns a boolean if a field has been set. + +### GetThreshold + +`func (o *AlertConfigViewForNdsGroup) GetThreshold() ThresholdViewInteger` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *AlertConfigViewForNdsGroup) GetThresholdOk() (*ThresholdViewInteger, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *AlertConfigViewForNdsGroup) SetThreshold(v ThresholdViewInteger)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *AlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertConfigurationsApi.md b/docs/docs/AlertConfigurationsApi.md new file mode 100644 index 00000000..a7fab27f --- /dev/null +++ b/docs/docs/AlertConfigurationsApi.md @@ -0,0 +1,630 @@ +# \AlertConfigurationsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateAlertConfiguration**](AlertConfigurationsApi.md#CreateAlertConfiguration) | **Post** /api/atlas/v2/groups/{groupId}/alertConfigs | Create One Alert Configuration in One Project +[**DeleteAlertConfiguration**](AlertConfigurationsApi.md#DeleteAlertConfiguration) | **Delete** /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} | Remove One Alert Configuration from One Project +[**GetAlertConfiguration**](AlertConfigurationsApi.md#GetAlertConfiguration) | **Get** /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} | Return One Alert Configuration from One Project +[**ListAlertConfigurationMatchersFieldNames**](AlertConfigurationsApi.md#ListAlertConfigurationMatchersFieldNames) | **Get** /api/atlas/v2/alertConfigs/matchers/fieldNames | Get All Alert Configuration Matchers Field Names +[**ListAlertConfigurations**](AlertConfigurationsApi.md#ListAlertConfigurations) | **Get** /api/atlas/v2/groups/{groupId}/alertConfigs | Return All Alert Configurations for One Project +[**ListAlertConfigurationsByAlertId**](AlertConfigurationsApi.md#ListAlertConfigurationsByAlertId) | **Get** /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs | Return All Alert Configurations Set for One Alert +[**ToggleAlertConfiguration**](AlertConfigurationsApi.md#ToggleAlertConfiguration) | **Patch** /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} | Toggle One State of One Alert Configuration in One Project +[**UpdateAlertConfiguration**](AlertConfigurationsApi.md#UpdateAlertConfiguration) | **Put** /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} | Update One Alert Configuration for One Project + + + +## CreateAlertConfiguration + +> AlertConfigViewForNdsGroup CreateAlertConfiguration(ctx, groupId).AlertConfigViewForNdsGroup(alertConfigViewForNdsGroup).Execute() + +Create One Alert Configuration in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertConfigViewForNdsGroup := *openapiclient.NewAlertConfigViewForNdsGroup() // AlertConfigViewForNdsGroup | + + resp, r, err := sdk.AlertConfigurationsApi.CreateAlertConfiguration(context.Background(), groupId).AlertConfigViewForNdsGroup(alertConfigViewForNdsGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.CreateAlertConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateAlertConfiguration`: AlertConfigViewForNdsGroup + fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.CreateAlertConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAlertConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **alertConfigViewForNdsGroup** | [**AlertConfigViewForNdsGroup**](AlertConfigViewForNdsGroup.md) | Creates one alert configuration for the specified project. | + +### Return type + +[**AlertConfigViewForNdsGroup**](AlertConfigViewForNdsGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteAlertConfiguration + +> DeleteAlertConfiguration(ctx, groupId, alertConfigId).Execute() + +Remove One Alert Configuration from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertConfigId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.AlertConfigurationsApi.DeleteAlertConfiguration(context.Background(), groupId, alertConfigId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.DeleteAlertConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAlertConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAlertConfiguration + +> AlertConfigViewForNdsGroup GetAlertConfiguration(ctx, groupId, alertConfigId).Execute() + +Return One Alert Configuration from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertConfigId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.AlertConfigurationsApi.GetAlertConfiguration(context.Background(), groupId, alertConfigId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.GetAlertConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetAlertConfiguration`: AlertConfigViewForNdsGroup + fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.GetAlertConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAlertConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**AlertConfigViewForNdsGroup**](AlertConfigViewForNdsGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListAlertConfigurationMatchersFieldNames + +> []MatcherField ListAlertConfigurationMatchersFieldNames(ctx).Execute() + +Get All Alert Configuration Matchers Field Names + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + + resp, r, err := sdk.AlertConfigurationsApi.ListAlertConfigurationMatchersFieldNames(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ListAlertConfigurationMatchersFieldNames``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListAlertConfigurationMatchersFieldNames`: []MatcherField + fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ListAlertConfigurationMatchersFieldNames`: %v\n", resp) +} +``` + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAlertConfigurationMatchersFieldNamesRequest struct via the builder pattern + + +### Return type + +[**[]MatcherField**](MatcherField.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListAlertConfigurations + +> PaginatedAlertConfig ListAlertConfigurations(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Alert Configurations for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.AlertConfigurationsApi.ListAlertConfigurations(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ListAlertConfigurations``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListAlertConfigurations`: PaginatedAlertConfig + fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ListAlertConfigurations`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAlertConfigurationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedAlertConfig**](PaginatedAlertConfig.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListAlertConfigurationsByAlertId + +> PaginatedAlertConfig ListAlertConfigurationsByAlertId(ctx, groupId, alertId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Alert Configurations Set for One Alert + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertId := "alertId_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.AlertConfigurationsApi.ListAlertConfigurationsByAlertId(context.Background(), groupId, alertId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ListAlertConfigurationsByAlertId``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListAlertConfigurationsByAlertId`: PaginatedAlertConfig + fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ListAlertConfigurationsByAlertId`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertId** | **string** | Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAlertConfigurationsByAlertIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedAlertConfig**](PaginatedAlertConfig.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ToggleAlertConfiguration + +> AlertConfigViewForNdsGroup ToggleAlertConfiguration(ctx, groupId, alertConfigId).Toggle(toggle).Execute() + +Toggle One State of One Alert Configuration in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertConfigId := "32b6e34b3d91647abb20e7b8" // string | + toggle := *openapiclient.NewToggle() // Toggle | + + resp, r, err := sdk.AlertConfigurationsApi.ToggleAlertConfiguration(context.Background(), groupId, alertConfigId).Toggle(toggle).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.ToggleAlertConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ToggleAlertConfiguration`: AlertConfigViewForNdsGroup + fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.ToggleAlertConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiToggleAlertConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **toggle** | [**Toggle**](Toggle.md) | Enables or disables the specified alert configuration in the specified project. | + +### Return type + +[**AlertConfigViewForNdsGroup**](AlertConfigViewForNdsGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateAlertConfiguration + +> AlertConfigViewForNdsGroup UpdateAlertConfiguration(ctx, groupId, alertConfigId).AlertConfigViewForNdsGroup(alertConfigViewForNdsGroup).Execute() + +Update One Alert Configuration for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertConfigId := "32b6e34b3d91647abb20e7b8" // string | + alertConfigViewForNdsGroup := *openapiclient.NewAlertConfigViewForNdsGroup() // AlertConfigViewForNdsGroup | + + resp, r, err := sdk.AlertConfigurationsApi.UpdateAlertConfiguration(context.Background(), groupId, alertConfigId).AlertConfigViewForNdsGroup(alertConfigViewForNdsGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertConfigurationsApi.UpdateAlertConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateAlertConfiguration`: AlertConfigViewForNdsGroup + fmt.Fprintf(os.Stdout, "Response from `AlertConfigurationsApi.UpdateAlertConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAlertConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **alertConfigViewForNdsGroup** | [**AlertConfigViewForNdsGroup**](AlertConfigViewForNdsGroup.md) | Updates one alert configuration in the specified project. | + +### Return type + +[**AlertConfigViewForNdsGroup**](AlertConfigViewForNdsGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/AlertViewForNdsGroup.md b/docs/docs/AlertViewForNdsGroup.md new file mode 100644 index 00000000..4a1d5d89 --- /dev/null +++ b/docs/docs/AlertViewForNdsGroup.md @@ -0,0 +1,576 @@ +# AlertViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | Pointer to **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | [optional] +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**EventTypeName** | Pointer to [**ReplicaSetEventTypeViewForNdsGroupAlertable**](ReplicaSetEventTypeViewForNdsGroupAlertable.md) | | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert. | [optional] [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | Pointer to **string** | State of this alert at the time you requested its details. | [optional] [readonly] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**CurrentValue** | Pointer to [**HostMetricValue**](HostMetricValue.md) | | [optional] +**MetricName** | Pointer to **string** | Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see <a href=\"https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types\" target=\"_blank\">Host Metrics</a>. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href=\"https://dochub.mongodb.org/core/alert-config-serverless-measurements\" target=\"_blank\">Serverless Measurements</a>. | [optional] [readonly] +**NonRunningHostIds** | Pointer to **[]string** | | [optional] [readonly] +**ParentClusterId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters. | [optional] [readonly] + +## Methods + +### NewAlertViewForNdsGroup + +`func NewAlertViewForNdsGroup() *AlertViewForNdsGroup` + +NewAlertViewForNdsGroup instantiates a new AlertViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAlertViewForNdsGroupWithDefaults + +`func NewAlertViewForNdsGroupWithDefaults() *AlertViewForNdsGroup` + +NewAlertViewForNdsGroupWithDefaults instantiates a new AlertViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *AlertViewForNdsGroup) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *AlertViewForNdsGroup) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *AlertViewForNdsGroup) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + +### HasAcknowledgedUntil + +`func (o *AlertViewForNdsGroup) HasAcknowledgedUntil() bool` + +HasAcknowledgedUntil returns a boolean if a field has been set. + +### GetAcknowledgementComment + +`func (o *AlertViewForNdsGroup) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *AlertViewForNdsGroup) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *AlertViewForNdsGroup) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *AlertViewForNdsGroup) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *AlertViewForNdsGroup) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *AlertViewForNdsGroup) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *AlertViewForNdsGroup) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *AlertViewForNdsGroup) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *AlertViewForNdsGroup) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *AlertViewForNdsGroup) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *AlertViewForNdsGroup) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + +### HasAlertConfigId + +`func (o *AlertViewForNdsGroup) HasAlertConfigId() bool` + +HasAlertConfigId returns a boolean if a field has been set. + +### GetCreated + +`func (o *AlertViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AlertViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AlertViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AlertViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *AlertViewForNdsGroup) GetEventTypeName() ReplicaSetEventTypeViewForNdsGroupAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AlertViewForNdsGroup) GetEventTypeNameOk() (*ReplicaSetEventTypeViewForNdsGroupAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AlertViewForNdsGroup) SetEventTypeName(v ReplicaSetEventTypeViewForNdsGroupAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + +### HasEventTypeName + +`func (o *AlertViewForNdsGroup) HasEventTypeName() bool` + +HasEventTypeName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *AlertViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AlertViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AlertViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AlertViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AlertViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AlertViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AlertViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AlertViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLastNotified + +`func (o *AlertViewForNdsGroup) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *AlertViewForNdsGroup) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *AlertViewForNdsGroup) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *AlertViewForNdsGroup) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *AlertViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AlertViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AlertViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AlertViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *AlertViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *AlertViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *AlertViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *AlertViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetResolved + +`func (o *AlertViewForNdsGroup) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *AlertViewForNdsGroup) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *AlertViewForNdsGroup) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *AlertViewForNdsGroup) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *AlertViewForNdsGroup) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AlertViewForNdsGroup) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AlertViewForNdsGroup) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AlertViewForNdsGroup) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetUpdated + +`func (o *AlertViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *AlertViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *AlertViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *AlertViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + +### GetClusterName + +`func (o *AlertViewForNdsGroup) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *AlertViewForNdsGroup) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *AlertViewForNdsGroup) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *AlertViewForNdsGroup) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *AlertViewForNdsGroup) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *AlertViewForNdsGroup) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *AlertViewForNdsGroup) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *AlertViewForNdsGroup) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *AlertViewForNdsGroup) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *AlertViewForNdsGroup) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *AlertViewForNdsGroup) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *AlertViewForNdsGroup) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetCurrentValue + +`func (o *AlertViewForNdsGroup) GetCurrentValue() HostMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *AlertViewForNdsGroup) GetCurrentValueOk() (*HostMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *AlertViewForNdsGroup) SetCurrentValue(v HostMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *AlertViewForNdsGroup) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetMetricName + +`func (o *AlertViewForNdsGroup) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *AlertViewForNdsGroup) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *AlertViewForNdsGroup) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *AlertViewForNdsGroup) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetNonRunningHostIds + +`func (o *AlertViewForNdsGroup) GetNonRunningHostIds() []string` + +GetNonRunningHostIds returns the NonRunningHostIds field if non-nil, zero value otherwise. + +### GetNonRunningHostIdsOk + +`func (o *AlertViewForNdsGroup) GetNonRunningHostIdsOk() (*[]string, bool)` + +GetNonRunningHostIdsOk returns a tuple with the NonRunningHostIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonRunningHostIds + +`func (o *AlertViewForNdsGroup) SetNonRunningHostIds(v []string)` + +SetNonRunningHostIds sets NonRunningHostIds field to given value. + +### HasNonRunningHostIds + +`func (o *AlertViewForNdsGroup) HasNonRunningHostIds() bool` + +HasNonRunningHostIds returns a boolean if a field has been set. + +### GetParentClusterId + +`func (o *AlertViewForNdsGroup) GetParentClusterId() string` + +GetParentClusterId returns the ParentClusterId field if non-nil, zero value otherwise. + +### GetParentClusterIdOk + +`func (o *AlertViewForNdsGroup) GetParentClusterIdOk() (*string, bool)` + +GetParentClusterIdOk returns a tuple with the ParentClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentClusterId + +`func (o *AlertViewForNdsGroup) SetParentClusterId(v string)` + +SetParentClusterId sets ParentClusterId field to given value. + +### HasParentClusterId + +`func (o *AlertViewForNdsGroup) HasParentClusterId() bool` + +HasParentClusterId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AlertsApi.md b/docs/docs/AlertsApi.md new file mode 100644 index 00000000..ae08a819 --- /dev/null +++ b/docs/docs/AlertsApi.md @@ -0,0 +1,333 @@ +# \AlertsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AcknowledgeAlert**](AlertsApi.md#AcknowledgeAlert) | **Patch** /api/atlas/v2/groups/{groupId}/alerts/{alertId} | Acknowledge One Alert from One Project +[**GetAlert**](AlertsApi.md#GetAlert) | **Get** /api/atlas/v2/groups/{groupId}/alerts/{alertId} | Return One Alert from One Project +[**ListAlerts**](AlertsApi.md#ListAlerts) | **Get** /api/atlas/v2/groups/{groupId}/alerts | Return All Alerts from One Project +[**ListAlertsByAlertConfigurationId**](AlertsApi.md#ListAlertsByAlertConfigurationId) | **Get** /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts | Return All Open Alerts for Alert Configuration + + + +## AcknowledgeAlert + +> AlertViewForNdsGroup AcknowledgeAlert(ctx, groupId, alertId).AlertViewForNdsGroup(alertViewForNdsGroup).Execute() + +Acknowledge One Alert from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertId := "alertId_example" // string | + alertViewForNdsGroup := *openapiclient.NewAlertViewForNdsGroup() // AlertViewForNdsGroup | + + resp, r, err := sdk.AlertsApi.AcknowledgeAlert(context.Background(), groupId, alertId).AlertViewForNdsGroup(alertViewForNdsGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertsApi.AcknowledgeAlert``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `AcknowledgeAlert`: AlertViewForNdsGroup + fmt.Fprintf(os.Stdout, "Response from `AlertsApi.AcknowledgeAlert`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertId** | **string** | Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAcknowledgeAlertRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **alertViewForNdsGroup** | [**AlertViewForNdsGroup**](AlertViewForNdsGroup.md) | Confirm one alert. | + +### Return type + +[**AlertViewForNdsGroup**](AlertViewForNdsGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAlert + +> AlertViewForNdsGroup GetAlert(ctx, groupId, alertId).Execute() + +Return One Alert from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertId := "alertId_example" // string | + + resp, r, err := sdk.AlertsApi.GetAlert(context.Background(), groupId, alertId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertsApi.GetAlert``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetAlert`: AlertViewForNdsGroup + fmt.Fprintf(os.Stdout, "Response from `AlertsApi.GetAlert`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertId** | **string** | Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAlertRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**AlertViewForNdsGroup**](AlertViewForNdsGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListAlerts + +> PaginatedAlert ListAlerts(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Status(status).Execute() + +Return All Alerts from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + status := "status_example" // string | (optional) + + resp, r, err := sdk.AlertsApi.ListAlerts(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Status(status).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertsApi.ListAlerts``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListAlerts`: PaginatedAlert + fmt.Fprintf(os.Stdout, "Response from `AlertsApi.ListAlerts`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAlertsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **status** | **string** | Status of the alerts to return. Omit to return all alerts in all statuses. | + +### Return type + +[**PaginatedAlert**](PaginatedAlert.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListAlertsByAlertConfigurationId + +> PaginatedAlert ListAlertsByAlertConfigurationId(ctx, groupId, alertConfigId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Open Alerts for Alert Configuration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + alertConfigId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.AlertsApi.ListAlertsByAlertConfigurationId(context.Background(), groupId, alertConfigId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AlertsApi.ListAlertsByAlertConfigurationId``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListAlertsByAlertConfigurationId`: PaginatedAlert + fmt.Fprintf(os.Stdout, "Response from `AlertsApi.ListAlertsByAlertConfigurationId`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**alertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAlertsByAlertConfigurationIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedAlert**](PaginatedAlert.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ApiAtlasPartitionFieldView.md b/docs/docs/ApiAtlasPartitionFieldView.md new file mode 100644 index 00000000..bd6a8b92 --- /dev/null +++ b/docs/docs/ApiAtlasPartitionFieldView.md @@ -0,0 +1,72 @@ +# ApiAtlasPartitionFieldView + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FieldName** | **string** | Human-readable label that identifies the field name used to partition data. | +**Order** | **int** | Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. | [default to 0] + +## Methods + +### NewApiAtlasPartitionFieldView + +`func NewApiAtlasPartitionFieldView(fieldName string, order int, ) *ApiAtlasPartitionFieldView` + +NewApiAtlasPartitionFieldView instantiates a new ApiAtlasPartitionFieldView object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewApiAtlasPartitionFieldViewWithDefaults + +`func NewApiAtlasPartitionFieldViewWithDefaults() *ApiAtlasPartitionFieldView` + +NewApiAtlasPartitionFieldViewWithDefaults instantiates a new ApiAtlasPartitionFieldView object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFieldName + +`func (o *ApiAtlasPartitionFieldView) GetFieldName() string` + +GetFieldName returns the FieldName field if non-nil, zero value otherwise. + +### GetFieldNameOk + +`func (o *ApiAtlasPartitionFieldView) GetFieldNameOk() (*string, bool)` + +GetFieldNameOk returns a tuple with the FieldName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFieldName + +`func (o *ApiAtlasPartitionFieldView) SetFieldName(v string)` + +SetFieldName sets FieldName field to given value. + + +### GetOrder + +`func (o *ApiAtlasPartitionFieldView) GetOrder() int` + +GetOrder returns the Order field if non-nil, zero value otherwise. + +### GetOrderOk + +`func (o *ApiAtlasPartitionFieldView) GetOrderOk() (*int, bool)` + +GetOrderOk returns a tuple with the Order field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrder + +`func (o *ApiAtlasPartitionFieldView) SetOrder(v int)` + +SetOrder sets Order field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ApiInstanceSizeView.md b/docs/docs/ApiInstanceSizeView.md new file mode 100644 index 00000000..8bc03192 --- /dev/null +++ b/docs/docs/ApiInstanceSizeView.md @@ -0,0 +1,82 @@ +# ApiInstanceSizeView + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AvailableRegions** | Pointer to [**[]AvailableRegion**](AvailableRegion.md) | List of regions that this cloud provider supports for this instance size. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the instance size or cluster tier. | [optional] [readonly] + +## Methods + +### NewApiInstanceSizeView + +`func NewApiInstanceSizeView() *ApiInstanceSizeView` + +NewApiInstanceSizeView instantiates a new ApiInstanceSizeView object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewApiInstanceSizeViewWithDefaults + +`func NewApiInstanceSizeViewWithDefaults() *ApiInstanceSizeView` + +NewApiInstanceSizeViewWithDefaults instantiates a new ApiInstanceSizeView object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAvailableRegions + +`func (o *ApiInstanceSizeView) GetAvailableRegions() []AvailableRegion` + +GetAvailableRegions returns the AvailableRegions field if non-nil, zero value otherwise. + +### GetAvailableRegionsOk + +`func (o *ApiInstanceSizeView) GetAvailableRegionsOk() (*[]AvailableRegion, bool)` + +GetAvailableRegionsOk returns a tuple with the AvailableRegions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvailableRegions + +`func (o *ApiInstanceSizeView) SetAvailableRegions(v []AvailableRegion)` + +SetAvailableRegions sets AvailableRegions field to given value. + +### HasAvailableRegions + +`func (o *ApiInstanceSizeView) HasAvailableRegions() bool` + +HasAvailableRegions returns a boolean if a field has been set. + +### GetName + +`func (o *ApiInstanceSizeView) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApiInstanceSizeView) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApiInstanceSizeView) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApiInstanceSizeView) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ApiRoleAssignmentView.md b/docs/docs/ApiRoleAssignmentView.md new file mode 100644 index 00000000..b21ed866 --- /dev/null +++ b/docs/docs/ApiRoleAssignmentView.md @@ -0,0 +1,108 @@ +# ApiRoleAssignmentView + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request. | [optional] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request. | [optional] +**RoleName** | Pointer to **string** | Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles. Organization Roles * ORG_OWNER * ORG_MEMBER * ORG_GROUP_CREATOR * ORG_BILLING_ADMIN * ORG_READ_ONLY Project Roles * GROUP_CLUSTER_MANAGER * GROUP_DATA_ACCESS_ADMIN * GROUP_DATA_ACCESS_READ_ONLY * GROUP_DATA_ACCESS_READ_WRITE * GROUP_OWNER * GROUP_READ_ONLY * GROUP_SEARCH_INDEX_EDITOR | [optional] + +## Methods + +### NewApiRoleAssignmentView + +`func NewApiRoleAssignmentView() *ApiRoleAssignmentView` + +NewApiRoleAssignmentView instantiates a new ApiRoleAssignmentView object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewApiRoleAssignmentViewWithDefaults + +`func NewApiRoleAssignmentViewWithDefaults() *ApiRoleAssignmentView` + +NewApiRoleAssignmentViewWithDefaults instantiates a new ApiRoleAssignmentView object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetGroupId + +`func (o *ApiRoleAssignmentView) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ApiRoleAssignmentView) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ApiRoleAssignmentView) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ApiRoleAssignmentView) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetOrgId + +`func (o *ApiRoleAssignmentView) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ApiRoleAssignmentView) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ApiRoleAssignmentView) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *ApiRoleAssignmentView) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetRoleName + +`func (o *ApiRoleAssignmentView) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *ApiRoleAssignmentView) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *ApiRoleAssignmentView) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + +### HasRoleName + +`func (o *ApiRoleAssignmentView) HasRoleName() bool` + +HasRoleName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ApiUser.md b/docs/docs/ApiUser.md new file mode 100644 index 00000000..20330704 --- /dev/null +++ b/docs/docs/ApiUser.md @@ -0,0 +1,186 @@ +# ApiUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Desc** | Pointer to **string** | Purpose or explanation provided when someone created this organization API key. | [optional] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**PrivateKey** | Pointer to **string** | Redacted private key returned for this organization API key. This key displays unredacted when first created. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public API key value set for the specified organization API key. | [optional] [readonly] +**Roles** | Pointer to [**[]RoleAssignment**](RoleAssignment.md) | List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key. | [optional] + +## Methods + +### NewApiUser + +`func NewApiUser() *ApiUser` + +NewApiUser instantiates a new ApiUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewApiUserWithDefaults + +`func NewApiUserWithDefaults() *ApiUser` + +NewApiUserWithDefaults instantiates a new ApiUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDesc + +`func (o *ApiUser) GetDesc() string` + +GetDesc returns the Desc field if non-nil, zero value otherwise. + +### GetDescOk + +`func (o *ApiUser) GetDescOk() (*string, bool)` + +GetDescOk returns a tuple with the Desc field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDesc + +`func (o *ApiUser) SetDesc(v string)` + +SetDesc sets Desc field to given value. + +### HasDesc + +`func (o *ApiUser) HasDesc() bool` + +HasDesc returns a boolean if a field has been set. + +### GetId + +`func (o *ApiUser) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApiUser) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApiUser) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApiUser) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ApiUser) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ApiUser) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ApiUser) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ApiUser) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetPrivateKey + +`func (o *ApiUser) GetPrivateKey() string` + +GetPrivateKey returns the PrivateKey field if non-nil, zero value otherwise. + +### GetPrivateKeyOk + +`func (o *ApiUser) GetPrivateKeyOk() (*string, bool)` + +GetPrivateKeyOk returns a tuple with the PrivateKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateKey + +`func (o *ApiUser) SetPrivateKey(v string)` + +SetPrivateKey sets PrivateKey field to given value. + +### HasPrivateKey + +`func (o *ApiUser) HasPrivateKey() bool` + +HasPrivateKey returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *ApiUser) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ApiUser) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ApiUser) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ApiUser) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRoles + +`func (o *ApiUser) GetRoles() []RoleAssignment` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *ApiUser) GetRolesOk() (*[]RoleAssignment, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *ApiUser) SetRoles(v []RoleAssignment)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *ApiUser) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ApiUserEventTypeViewForNdsGroup.md b/docs/docs/ApiUserEventTypeViewForNdsGroup.md new file mode 100644 index 00000000..7089312f --- /dev/null +++ b/docs/docs/ApiUserEventTypeViewForNdsGroup.md @@ -0,0 +1,29 @@ +# ApiUserEventTypeViewForNdsGroup + +## Enum + + +* `CREATED` (value: `"API_KEY_CREATED"`) + +* `DELETED` (value: `"API_KEY_DELETED"`) + +* `ACCESS_LIST_ENTRY_ADDED` (value: `"API_KEY_ACCESS_LIST_ENTRY_ADDED"`) + +* `ACCESS_LIST_ENTRY_DELETED` (value: `"API_KEY_ACCESS_LIST_ENTRY_DELETED"`) + +* `ROLES_CHANGED` (value: `"API_KEY_ROLES_CHANGED"`) + +* `DESCRIPTION_CHANGED` (value: `"API_KEY_DESCRIPTION_CHANGED"`) + +* `ADDED_TO_GROUP` (value: `"API_KEY_ADDED_TO_GROUP"`) + +* `REMOVED_FROM_GROUP` (value: `"API_KEY_REMOVED_FROM_GROUP"`) + +* `UI_IP_ACCESS_LIST_INHERITANCE_ENABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED"`) + +* `UI_IP_ACCESS_LIST_INHERITANCE_DISABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ApiUserEventTypeViewForOrg.md b/docs/docs/ApiUserEventTypeViewForOrg.md new file mode 100644 index 00000000..98136982 --- /dev/null +++ b/docs/docs/ApiUserEventTypeViewForOrg.md @@ -0,0 +1,29 @@ +# ApiUserEventTypeViewForOrg + +## Enum + + +* `CREATED` (value: `"API_KEY_CREATED"`) + +* `DELETED` (value: `"API_KEY_DELETED"`) + +* `ACCESS_LIST_ENTRY_ADDED` (value: `"API_KEY_ACCESS_LIST_ENTRY_ADDED"`) + +* `ACCESS_LIST_ENTRY_DELETED` (value: `"API_KEY_ACCESS_LIST_ENTRY_DELETED"`) + +* `ROLES_CHANGED` (value: `"API_KEY_ROLES_CHANGED"`) + +* `DESCRIPTION_CHANGED` (value: `"API_KEY_DESCRIPTION_CHANGED"`) + +* `ADDED_TO_GROUP` (value: `"API_KEY_ADDED_TO_GROUP"`) + +* `REMOVED_FROM_GROUP` (value: `"API_KEY_REMOVED_FROM_GROUP"`) + +* `UI_IP_ACCESS_LIST_INHERITANCE_ENABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED"`) + +* `UI_IP_ACCESS_LIST_INHERITANCE_DISABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ApiUserEventViewForNdsGroup.md b/docs/docs/ApiUserEventViewForNdsGroup.md new file mode 100644 index 00000000..c1402463 --- /dev/null +++ b/docs/docs/ApiUserEventViewForNdsGroup.md @@ -0,0 +1,353 @@ +# ApiUserEventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**UserEventTypeViewForNdsGroup**](UserEventTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewApiUserEventViewForNdsGroup + +`func NewApiUserEventViewForNdsGroup(created time.Time, eventTypeName UserEventTypeViewForNdsGroup, id string, ) *ApiUserEventViewForNdsGroup` + +NewApiUserEventViewForNdsGroup instantiates a new ApiUserEventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewApiUserEventViewForNdsGroupWithDefaults + +`func NewApiUserEventViewForNdsGroupWithDefaults() *ApiUserEventViewForNdsGroup` + +NewApiUserEventViewForNdsGroupWithDefaults instantiates a new ApiUserEventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *ApiUserEventViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *ApiUserEventViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *ApiUserEventViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *ApiUserEventViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *ApiUserEventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ApiUserEventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ApiUserEventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *ApiUserEventViewForNdsGroup) GetEventTypeName() UserEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ApiUserEventViewForNdsGroup) GetEventTypeNameOk() (*UserEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ApiUserEventViewForNdsGroup) SetEventTypeName(v UserEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ApiUserEventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ApiUserEventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ApiUserEventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ApiUserEventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ApiUserEventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApiUserEventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApiUserEventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *ApiUserEventViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *ApiUserEventViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *ApiUserEventViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *ApiUserEventViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *ApiUserEventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ApiUserEventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ApiUserEventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ApiUserEventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *ApiUserEventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ApiUserEventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ApiUserEventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *ApiUserEventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *ApiUserEventViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ApiUserEventViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ApiUserEventViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ApiUserEventViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *ApiUserEventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *ApiUserEventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *ApiUserEventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *ApiUserEventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *ApiUserEventViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *ApiUserEventViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *ApiUserEventViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *ApiUserEventViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *ApiUserEventViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *ApiUserEventViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *ApiUserEventViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *ApiUserEventViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *ApiUserEventViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *ApiUserEventViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *ApiUserEventViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *ApiUserEventViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ApiUserEventViewForOrg.md b/docs/docs/ApiUserEventViewForOrg.md new file mode 100644 index 00000000..c41abe2e --- /dev/null +++ b/docs/docs/ApiUserEventViewForOrg.md @@ -0,0 +1,353 @@ +# ApiUserEventViewForOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**UserEventTypeViewForOrg**](UserEventTypeViewForOrg.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewApiUserEventViewForOrg + +`func NewApiUserEventViewForOrg(created time.Time, eventTypeName UserEventTypeViewForOrg, id string, ) *ApiUserEventViewForOrg` + +NewApiUserEventViewForOrg instantiates a new ApiUserEventViewForOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewApiUserEventViewForOrgWithDefaults + +`func NewApiUserEventViewForOrgWithDefaults() *ApiUserEventViewForOrg` + +NewApiUserEventViewForOrgWithDefaults instantiates a new ApiUserEventViewForOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *ApiUserEventViewForOrg) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *ApiUserEventViewForOrg) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *ApiUserEventViewForOrg) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *ApiUserEventViewForOrg) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *ApiUserEventViewForOrg) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ApiUserEventViewForOrg) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ApiUserEventViewForOrg) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *ApiUserEventViewForOrg) GetEventTypeName() UserEventTypeViewForOrg` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ApiUserEventViewForOrg) GetEventTypeNameOk() (*UserEventTypeViewForOrg, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ApiUserEventViewForOrg) SetEventTypeName(v UserEventTypeViewForOrg)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ApiUserEventViewForOrg) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ApiUserEventViewForOrg) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ApiUserEventViewForOrg) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ApiUserEventViewForOrg) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ApiUserEventViewForOrg) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApiUserEventViewForOrg) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApiUserEventViewForOrg) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *ApiUserEventViewForOrg) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *ApiUserEventViewForOrg) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *ApiUserEventViewForOrg) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *ApiUserEventViewForOrg) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *ApiUserEventViewForOrg) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ApiUserEventViewForOrg) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ApiUserEventViewForOrg) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ApiUserEventViewForOrg) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *ApiUserEventViewForOrg) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ApiUserEventViewForOrg) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ApiUserEventViewForOrg) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *ApiUserEventViewForOrg) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *ApiUserEventViewForOrg) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ApiUserEventViewForOrg) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ApiUserEventViewForOrg) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ApiUserEventViewForOrg) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *ApiUserEventViewForOrg) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *ApiUserEventViewForOrg) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *ApiUserEventViewForOrg) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *ApiUserEventViewForOrg) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *ApiUserEventViewForOrg) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *ApiUserEventViewForOrg) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *ApiUserEventViewForOrg) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *ApiUserEventViewForOrg) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *ApiUserEventViewForOrg) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *ApiUserEventViewForOrg) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *ApiUserEventViewForOrg) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *ApiUserEventViewForOrg) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *ApiUserEventViewForOrg) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *ApiUserEventViewForOrg) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *ApiUserEventViewForOrg) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *ApiUserEventViewForOrg) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceAlert.md b/docs/docs/AppServiceAlert.md new file mode 100644 index 00000000..e0918f41 --- /dev/null +++ b/docs/docs/AppServiceAlert.md @@ -0,0 +1,359 @@ +# AppServiceAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**AppServiceEventTypeViewAlertable**](AppServiceEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewAppServiceAlert + +`func NewAppServiceAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName AppServiceEventTypeViewAlertable, id string, status string, updated time.Time, ) *AppServiceAlert` + +NewAppServiceAlert instantiates a new AppServiceAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAppServiceAlertWithDefaults + +`func NewAppServiceAlertWithDefaults() *AppServiceAlert` + +NewAppServiceAlertWithDefaults instantiates a new AppServiceAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *AppServiceAlert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *AppServiceAlert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *AppServiceAlert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *AppServiceAlert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *AppServiceAlert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *AppServiceAlert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *AppServiceAlert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *AppServiceAlert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *AppServiceAlert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *AppServiceAlert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *AppServiceAlert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *AppServiceAlert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *AppServiceAlert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *AppServiceAlert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetCreated + +`func (o *AppServiceAlert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AppServiceAlert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AppServiceAlert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *AppServiceAlert) GetEventTypeName() AppServiceEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AppServiceAlert) GetEventTypeNameOk() (*AppServiceEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AppServiceAlert) SetEventTypeName(v AppServiceEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *AppServiceAlert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AppServiceAlert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AppServiceAlert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AppServiceAlert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AppServiceAlert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppServiceAlert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppServiceAlert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *AppServiceAlert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *AppServiceAlert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *AppServiceAlert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *AppServiceAlert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *AppServiceAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AppServiceAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AppServiceAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AppServiceAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *AppServiceAlert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *AppServiceAlert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *AppServiceAlert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *AppServiceAlert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetResolved + +`func (o *AppServiceAlert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *AppServiceAlert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *AppServiceAlert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *AppServiceAlert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *AppServiceAlert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AppServiceAlert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AppServiceAlert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *AppServiceAlert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *AppServiceAlert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *AppServiceAlert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceAlertConfigViewForNdsGroup.md b/docs/docs/AppServiceAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..7d61b254 --- /dev/null +++ b/docs/docs/AppServiceAlertConfigViewForNdsGroup.md @@ -0,0 +1,259 @@ +# AppServiceAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**AppServiceEventTypeViewAlertableNoThreshold**](AppServiceEventTypeViewAlertableNoThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]AppServiceMetricMatcher**](AppServiceMetricMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewAppServiceAlertConfigViewForNdsGroup + +`func NewAppServiceAlertConfigViewForNdsGroup(eventTypeName AppServiceEventTypeViewAlertableNoThreshold, ) *AppServiceAlertConfigViewForNdsGroup` + +NewAppServiceAlertConfigViewForNdsGroup instantiates a new AppServiceAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAppServiceAlertConfigViewForNdsGroupWithDefaults + +`func NewAppServiceAlertConfigViewForNdsGroupWithDefaults() *AppServiceAlertConfigViewForNdsGroup` + +NewAppServiceAlertConfigViewForNdsGroupWithDefaults instantiates a new AppServiceAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetEventTypeName() AppServiceEventTypeViewAlertableNoThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*AppServiceEventTypeViewAlertableNoThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetEventTypeName(v AppServiceEventTypeViewAlertableNoThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetMatchers() []AppServiceMetricMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetMatchersOk() (*[]AppServiceMetricMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetMatchers(v []AppServiceMetricMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *AppServiceAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *AppServiceAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *AppServiceAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceEvent.md b/docs/docs/AppServiceEvent.md new file mode 100644 index 00000000..826c474c --- /dev/null +++ b/docs/docs/AppServiceEvent.md @@ -0,0 +1,197 @@ +# AppServiceEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**AppServiceEventType**](AppServiceEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] + +## Methods + +### NewAppServiceEvent + +`func NewAppServiceEvent(created time.Time, eventTypeName AppServiceEventType, id string, ) *AppServiceEvent` + +NewAppServiceEvent instantiates a new AppServiceEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAppServiceEventWithDefaults + +`func NewAppServiceEventWithDefaults() *AppServiceEvent` + +NewAppServiceEventWithDefaults instantiates a new AppServiceEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *AppServiceEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AppServiceEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AppServiceEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *AppServiceEvent) GetEventTypeName() AppServiceEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AppServiceEvent) GetEventTypeNameOk() (*AppServiceEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AppServiceEvent) SetEventTypeName(v AppServiceEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *AppServiceEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AppServiceEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AppServiceEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AppServiceEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AppServiceEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppServiceEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppServiceEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLinks + +`func (o *AppServiceEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AppServiceEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AppServiceEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AppServiceEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *AppServiceEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *AppServiceEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *AppServiceEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *AppServiceEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetRaw + +`func (o *AppServiceEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *AppServiceEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *AppServiceEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *AppServiceEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceEventType.md b/docs/docs/AppServiceEventType.md new file mode 100644 index 00000000..3fc18a08 --- /dev/null +++ b/docs/docs/AppServiceEventType.md @@ -0,0 +1,33 @@ +# AppServiceEventType + +## Enum + + +* `URL_CONFIRMATION` (value: `"URL_CONFIRMATION"`) + +* `SUCCESSFUL_DEPLOY` (value: `"SUCCESSFUL_DEPLOY"`) + +* `DEPLOYMENT_FAILURE` (value: `"DEPLOYMENT_FAILURE"`) + +* `DEPLOYMENT_MODEL_CHANGE_SUCCESS` (value: `"DEPLOYMENT_MODEL_CHANGE_SUCCESS"`) + +* `DEPLOYMENT_MODEL_CHANGE_FAILURE` (value: `"DEPLOYMENT_MODEL_CHANGE_FAILURE"`) + +* `REQUEST_RATE_LIMIT` (value: `"REQUEST_RATE_LIMIT"`) + +* `LOG_FORWARDER_FAILURE` (value: `"LOG_FORWARDER_FAILURE"`) + +* `INSIDE_REALM_METRIC_THRESHOLD` (value: `"INSIDE_REALM_METRIC_THRESHOLD"`) + +* `OUTSIDE_REALM_METRIC_THRESHOLD` (value: `"OUTSIDE_REALM_METRIC_THRESHOLD"`) + +* `SYNC_FAILURE` (value: `"SYNC_FAILURE"`) + +* `TRIGGER_FAILURE` (value: `"TRIGGER_FAILURE"`) + +* `TRIGGER_AUTO_RESUMED` (value: `"TRIGGER_AUTO_RESUMED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceEventTypeViewAlertable.md b/docs/docs/AppServiceEventTypeViewAlertable.md new file mode 100644 index 00000000..954b5331 --- /dev/null +++ b/docs/docs/AppServiceEventTypeViewAlertable.md @@ -0,0 +1,31 @@ +# AppServiceEventTypeViewAlertable + +## Enum + + +* `URL_CONFIRMATION` (value: `"URL_CONFIRMATION"`) + +* `SUCCESSFUL_DEPLOY` (value: `"SUCCESSFUL_DEPLOY"`) + +* `DEPLOYMENT_FAILURE` (value: `"DEPLOYMENT_FAILURE"`) + +* `DEPLOYMENT_MODEL_CHANGE_SUCCESS` (value: `"DEPLOYMENT_MODEL_CHANGE_SUCCESS"`) + +* `DEPLOYMENT_MODEL_CHANGE_FAILURE` (value: `"DEPLOYMENT_MODEL_CHANGE_FAILURE"`) + +* `REQUEST_RATE_LIMIT` (value: `"REQUEST_RATE_LIMIT"`) + +* `LOG_FORWARDER_FAILURE` (value: `"LOG_FORWARDER_FAILURE"`) + +* `OUTSIDE_REALM_METRIC_THRESHOLD` (value: `"OUTSIDE_REALM_METRIC_THRESHOLD"`) + +* `SYNC_FAILURE` (value: `"SYNC_FAILURE"`) + +* `TRIGGER_FAILURE` (value: `"TRIGGER_FAILURE"`) + +* `TRIGGER_AUTO_RESUMED` (value: `"TRIGGER_AUTO_RESUMED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceEventTypeViewAlertableNoThreshold.md b/docs/docs/AppServiceEventTypeViewAlertableNoThreshold.md new file mode 100644 index 00000000..9047d109 --- /dev/null +++ b/docs/docs/AppServiceEventTypeViewAlertableNoThreshold.md @@ -0,0 +1,29 @@ +# AppServiceEventTypeViewAlertableNoThreshold + +## Enum + + +* `URL_CONFIRMATION` (value: `"URL_CONFIRMATION"`) + +* `SUCCESSFUL_DEPLOY` (value: `"SUCCESSFUL_DEPLOY"`) + +* `DEPLOYMENT_FAILURE` (value: `"DEPLOYMENT_FAILURE"`) + +* `REQUEST_RATE_LIMIT` (value: `"REQUEST_RATE_LIMIT"`) + +* `LOG_FORWARDER_FAILURE` (value: `"LOG_FORWARDER_FAILURE"`) + +* `SYNC_FAILURE` (value: `"SYNC_FAILURE"`) + +* `TRIGGER_FAILURE` (value: `"TRIGGER_FAILURE"`) + +* `TRIGGER_AUTO_RESUMED` (value: `"TRIGGER_AUTO_RESUMED"`) + +* `DEPLOYMENT_MODEL_CHANGE_SUCCESS` (value: `"DEPLOYMENT_MODEL_CHANGE_SUCCESS"`) + +* `DEPLOYMENT_MODEL_CHANGE_FAILURE` (value: `"DEPLOYMENT_MODEL_CHANGE_FAILURE"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceEventTypeViewAlertableWithThreshold.md b/docs/docs/AppServiceEventTypeViewAlertableWithThreshold.md new file mode 100644 index 00000000..94de7970 --- /dev/null +++ b/docs/docs/AppServiceEventTypeViewAlertableWithThreshold.md @@ -0,0 +1,11 @@ +# AppServiceEventTypeViewAlertableWithThreshold + +## Enum + + +* `OUTSIDE_REALM_METRIC_THRESHOLD` (value: `"OUTSIDE_REALM_METRIC_THRESHOLD"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceMetricAlertConfigViewForNdsGroup.md b/docs/docs/AppServiceMetricAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..1c70311e --- /dev/null +++ b/docs/docs/AppServiceMetricAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# AppServiceMetricAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**AppServiceEventTypeViewAlertableWithThreshold**](AppServiceEventTypeViewAlertableWithThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]AppServiceMetricMatcher**](AppServiceMetricMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**MetricThreshold** | Pointer to [**AppServiceMetricThreshold**](AppServiceMetricThreshold.md) | | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewAppServiceMetricAlertConfigViewForNdsGroup + +`func NewAppServiceMetricAlertConfigViewForNdsGroup(eventTypeName AppServiceEventTypeViewAlertableWithThreshold, ) *AppServiceMetricAlertConfigViewForNdsGroup` + +NewAppServiceMetricAlertConfigViewForNdsGroup instantiates a new AppServiceMetricAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAppServiceMetricAlertConfigViewForNdsGroupWithDefaults + +`func NewAppServiceMetricAlertConfigViewForNdsGroupWithDefaults() *AppServiceMetricAlertConfigViewForNdsGroup` + +NewAppServiceMetricAlertConfigViewForNdsGroupWithDefaults instantiates a new AppServiceMetricAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetEventTypeName() AppServiceEventTypeViewAlertableWithThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*AppServiceEventTypeViewAlertableWithThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetEventTypeName(v AppServiceEventTypeViewAlertableWithThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetMatchers() []AppServiceMetricMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetMatchersOk() (*[]AppServiceMetricMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetMatchers(v []AppServiceMetricMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetMetricThreshold + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetMetricThreshold() AppServiceMetricThreshold` + +GetMetricThreshold returns the MetricThreshold field if non-nil, zero value otherwise. + +### GetMetricThresholdOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetMetricThresholdOk() (*AppServiceMetricThreshold, bool)` + +GetMetricThresholdOk returns a tuple with the MetricThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricThreshold + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetMetricThreshold(v AppServiceMetricThreshold)` + +SetMetricThreshold sets MetricThreshold field to given value. + +### HasMetricThreshold + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasMetricThreshold() bool` + +HasMetricThreshold returns a boolean if a field has been set. + +### GetNotifications + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *AppServiceMetricAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceMetricMatcher.md b/docs/docs/AppServiceMetricMatcher.md new file mode 100644 index 00000000..9ed9c55c --- /dev/null +++ b/docs/docs/AppServiceMetricMatcher.md @@ -0,0 +1,108 @@ +# AppServiceMetricMatcher + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FieldName** | Pointer to [**AppServiceMetricMatcherField**](AppServiceMetricMatcherField.md) | | [optional] +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value against **matcher[n].value**. | [optional] +**Value** | Pointer to **string** | Value to match or exceed using the specified **matchers.operator**. | [optional] + +## Methods + +### NewAppServiceMetricMatcher + +`func NewAppServiceMetricMatcher() *AppServiceMetricMatcher` + +NewAppServiceMetricMatcher instantiates a new AppServiceMetricMatcher object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAppServiceMetricMatcherWithDefaults + +`func NewAppServiceMetricMatcherWithDefaults() *AppServiceMetricMatcher` + +NewAppServiceMetricMatcherWithDefaults instantiates a new AppServiceMetricMatcher object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFieldName + +`func (o *AppServiceMetricMatcher) GetFieldName() AppServiceMetricMatcherField` + +GetFieldName returns the FieldName field if non-nil, zero value otherwise. + +### GetFieldNameOk + +`func (o *AppServiceMetricMatcher) GetFieldNameOk() (*AppServiceMetricMatcherField, bool)` + +GetFieldNameOk returns a tuple with the FieldName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFieldName + +`func (o *AppServiceMetricMatcher) SetFieldName(v AppServiceMetricMatcherField)` + +SetFieldName sets FieldName field to given value. + +### HasFieldName + +`func (o *AppServiceMetricMatcher) HasFieldName() bool` + +HasFieldName returns a boolean if a field has been set. + +### GetOperator + +`func (o *AppServiceMetricMatcher) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *AppServiceMetricMatcher) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *AppServiceMetricMatcher) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *AppServiceMetricMatcher) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetValue + +`func (o *AppServiceMetricMatcher) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AppServiceMetricMatcher) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AppServiceMetricMatcher) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AppServiceMetricMatcher) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceMetricMatcherField.md b/docs/docs/AppServiceMetricMatcherField.md new file mode 100644 index 00000000..01d9db68 --- /dev/null +++ b/docs/docs/AppServiceMetricMatcherField.md @@ -0,0 +1,11 @@ +# AppServiceMetricMatcherField + +## Enum + + +* `APPLICATION_ID` (value: `"APPLICATION_ID"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppServiceMetricThreshold.md b/docs/docs/AppServiceMetricThreshold.md new file mode 100644 index 00000000..c5a4f53c --- /dev/null +++ b/docs/docs/AppServiceMetricThreshold.md @@ -0,0 +1,160 @@ +# AppServiceMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**DataMetricUnits**](DataMetricUnits.md) | | [optional] + +## Methods + +### NewAppServiceMetricThreshold + +`func NewAppServiceMetricThreshold() *AppServiceMetricThreshold` + +NewAppServiceMetricThreshold instantiates a new AppServiceMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAppServiceMetricThresholdWithDefaults + +`func NewAppServiceMetricThresholdWithDefaults() *AppServiceMetricThreshold` + +NewAppServiceMetricThresholdWithDefaults instantiates a new AppServiceMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *AppServiceMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *AppServiceMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *AppServiceMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *AppServiceMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *AppServiceMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *AppServiceMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *AppServiceMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *AppServiceMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *AppServiceMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *AppServiceMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *AppServiceMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *AppServiceMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *AppServiceMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *AppServiceMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *AppServiceMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *AppServiceMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *AppServiceMetricThreshold) GetUnits() DataMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *AppServiceMetricThreshold) GetUnitsOk() (*DataMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *AppServiceMetricThreshold) SetUnits(v DataMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *AppServiceMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AppUser.md b/docs/docs/AppUser.md new file mode 100644 index 00000000..1e1d60f5 --- /dev/null +++ b/docs/docs/AppUser.md @@ -0,0 +1,333 @@ +# AppUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Country** | **string** | Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format. | +**CreatedAt** | Pointer to **time.Time** | Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**EmailAddress** | **string** | Email address that belongs to the MongoDB Cloud user. | +**FirstName** | **string** | First or given name that belongs to the MongoDB Cloud user. | +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user. | [optional] [readonly] +**LastAuth** | Pointer to **time.Time** | Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**LastName** | **string** | Last name, family name, or surname that belongs to the MongoDB Cloud user. | +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MobileNumber** | **string** | Mobile phone number that belongs to the MongoDB Cloud user. | +**Password** | **string** | Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console. | +**Roles** | Pointer to [**[]RoleAssignment**](RoleAssignment.md) | List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both. | [optional] +**TeamIds** | Pointer to **[]string** | List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs. | [optional] [readonly] +**Username** | **string** | Email address that represents the username of the MongoDB Cloud user. | + +## Methods + +### NewAppUser + +`func NewAppUser(country string, emailAddress string, firstName string, lastName string, mobileNumber string, password string, username string, ) *AppUser` + +NewAppUser instantiates a new AppUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAppUserWithDefaults + +`func NewAppUserWithDefaults() *AppUser` + +NewAppUserWithDefaults instantiates a new AppUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCountry + +`func (o *AppUser) GetCountry() string` + +GetCountry returns the Country field if non-nil, zero value otherwise. + +### GetCountryOk + +`func (o *AppUser) GetCountryOk() (*string, bool)` + +GetCountryOk returns a tuple with the Country field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCountry + +`func (o *AppUser) SetCountry(v string)` + +SetCountry sets Country field to given value. + + +### GetCreatedAt + +`func (o *AppUser) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *AppUser) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *AppUser) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *AppUser) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *AppUser) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *AppUser) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *AppUser) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + + +### GetFirstName + +`func (o *AppUser) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *AppUser) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *AppUser) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + + +### GetId + +`func (o *AppUser) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppUser) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppUser) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppUser) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLastAuth + +`func (o *AppUser) GetLastAuth() time.Time` + +GetLastAuth returns the LastAuth field if non-nil, zero value otherwise. + +### GetLastAuthOk + +`func (o *AppUser) GetLastAuthOk() (*time.Time, bool)` + +GetLastAuthOk returns a tuple with the LastAuth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastAuth + +`func (o *AppUser) SetLastAuth(v time.Time)` + +SetLastAuth sets LastAuth field to given value. + +### HasLastAuth + +`func (o *AppUser) HasLastAuth() bool` + +HasLastAuth returns a boolean if a field has been set. + +### GetLastName + +`func (o *AppUser) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *AppUser) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *AppUser) SetLastName(v string)` + +SetLastName sets LastName field to given value. + + +### GetLinks + +`func (o *AppUser) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AppUser) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AppUser) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AppUser) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMobileNumber + +`func (o *AppUser) GetMobileNumber() string` + +GetMobileNumber returns the MobileNumber field if non-nil, zero value otherwise. + +### GetMobileNumberOk + +`func (o *AppUser) GetMobileNumberOk() (*string, bool)` + +GetMobileNumberOk returns a tuple with the MobileNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMobileNumber + +`func (o *AppUser) SetMobileNumber(v string)` + +SetMobileNumber sets MobileNumber field to given value. + + +### GetPassword + +`func (o *AppUser) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *AppUser) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *AppUser) SetPassword(v string)` + +SetPassword sets Password field to given value. + + +### GetRoles + +`func (o *AppUser) GetRoles() []RoleAssignment` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *AppUser) GetRolesOk() (*[]RoleAssignment, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *AppUser) SetRoles(v []RoleAssignment)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *AppUser) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetTeamIds + +`func (o *AppUser) GetTeamIds() []string` + +GetTeamIds returns the TeamIds field if non-nil, zero value otherwise. + +### GetTeamIdsOk + +`func (o *AppUser) GetTeamIdsOk() (*[]string, bool)` + +GetTeamIdsOk returns a tuple with the TeamIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamIds + +`func (o *AppUser) SetTeamIds(v []string)` + +SetTeamIds sets TeamIds field to given value. + +### HasTeamIds + +`func (o *AppUser) HasTeamIds() bool` + +HasTeamIds returns a boolean if a field has been set. + +### GetUsername + +`func (o *AppUser) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *AppUser) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *AppUser) SetUsername(v string)` + +SetUsername sets Username field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AtlasSearchApi.md b/docs/docs/AtlasSearchApi.md new file mode 100644 index 00000000..68ab6d9f --- /dev/null +++ b/docs/docs/AtlasSearchApi.md @@ -0,0 +1,415 @@ +# \AtlasSearchApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateAtlasSearchIndex**](AtlasSearchApi.md#CreateAtlasSearchIndex) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes | Create One Atlas Search Index +[**DeleteAtlasSearchIndex**](AtlasSearchApi.md#DeleteAtlasSearchIndex) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} | Remove One Atlas Search Index +[**GetAtlasSearchIndex**](AtlasSearchApi.md#GetAtlasSearchIndex) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} | Return One Atlas Search Index +[**ListAtlasSearchIndexes**](AtlasSearchApi.md#ListAtlasSearchIndexes) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName} | Return All Atlas Search Indexes for One Collection +[**UpdateAtlasSearchIndex**](AtlasSearchApi.md#UpdateAtlasSearchIndex) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} | Update One Atlas Search Index + + + +## CreateAtlasSearchIndex + +> FTSIndex CreateAtlasSearchIndex(ctx, groupId, clusterName).FTSIndex(fTSIndex).Execute() + +Create One Atlas Search Index + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + fTSIndex := *openapiclient.NewFTSIndex("CollectionName_example", "Database_example", "Name_example") // FTSIndex | + + resp, r, err := sdk.AtlasSearchApi.CreateAtlasSearchIndex(context.Background(), groupId, clusterName).FTSIndex(fTSIndex).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AtlasSearchApi.CreateAtlasSearchIndex``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateAtlasSearchIndex`: FTSIndex + fmt.Fprintf(os.Stdout, "Response from `AtlasSearchApi.CreateAtlasSearchIndex`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Name of the cluster that contains the collection on which to create an Atlas Search index. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAtlasSearchIndexRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **fTSIndex** | [**FTSIndex**](FTSIndex.md) | Creates one Atlas Search index on the specified collection. | + +### Return type + +[**FTSIndex**](FTSIndex.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteAtlasSearchIndex + +> DeleteAtlasSearchIndex(ctx, groupId, clusterName, indexId).Execute() + +Remove One Atlas Search Index + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + indexId := "indexId_example" // string | + + r, err := sdk.AtlasSearchApi.DeleteAtlasSearchIndex(context.Background(), groupId, clusterName, indexId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AtlasSearchApi.DeleteAtlasSearchIndex``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Name of the cluster that contains the database and collection with one or more Application Search indexes. | +**indexId** | **string** | Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAtlasSearchIndexRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetAtlasSearchIndex + +> FTSIndex GetAtlasSearchIndex(ctx, groupId, clusterName, indexId).Execute() + +Return One Atlas Search Index + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + indexId := "indexId_example" // string | + + resp, r, err := sdk.AtlasSearchApi.GetAtlasSearchIndex(context.Background(), groupId, clusterName, indexId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AtlasSearchApi.GetAtlasSearchIndex``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetAtlasSearchIndex`: FTSIndex + fmt.Fprintf(os.Stdout, "Response from `AtlasSearchApi.GetAtlasSearchIndex`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Name of the cluster that contains the collection with one or more Atlas Search indexes. | +**indexId** | **string** | Unique 24-hexadecimal digit string that identifies the Application Search [index](https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAtlasSearchIndexRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**FTSIndex**](FTSIndex.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListAtlasSearchIndexes + +> []FTSIndex ListAtlasSearchIndexes(ctx, groupId, clusterName, collectionName, databaseName).Execute() + +Return All Atlas Search Indexes for One Collection + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + collectionName := "collectionName_example" // string | + databaseName := "databaseName_example" // string | + + resp, r, err := sdk.AtlasSearchApi.ListAtlasSearchIndexes(context.Background(), groupId, clusterName, collectionName, databaseName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AtlasSearchApi.ListAtlasSearchIndexes``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListAtlasSearchIndexes`: []FTSIndex + fmt.Fprintf(os.Stdout, "Response from `AtlasSearchApi.ListAtlasSearchIndexes`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Name of the cluster that contains the collection with one or more Atlas Search indexes. | +**collectionName** | **string** | Name of the collection that contains one or more Atlas Search indexes. | +**databaseName** | **string** | Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAtlasSearchIndexesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + + +### Return type + +[**[]FTSIndex**](FTSIndex.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateAtlasSearchIndex + +> FTSIndex UpdateAtlasSearchIndex(ctx, groupId, clusterName, indexId).FTSIndex(fTSIndex).Execute() + +Update One Atlas Search Index + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + indexId := "indexId_example" // string | + fTSIndex := *openapiclient.NewFTSIndex("CollectionName_example", "Database_example", "Name_example") // FTSIndex | + + resp, r, err := sdk.AtlasSearchApi.UpdateAtlasSearchIndex(context.Background(), groupId, clusterName, indexId).FTSIndex(fTSIndex).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AtlasSearchApi.UpdateAtlasSearchIndex``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateAtlasSearchIndex`: FTSIndex + fmt.Fprintf(os.Stdout, "Response from `AtlasSearchApi.UpdateAtlasSearchIndex`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Name of the cluster that contains the collection whose Atlas Search index to update. | +**indexId** | **string** | Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://docs.atlas.mongodb.com/reference/atlas-search/index-definitions/). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAtlasSearchIndexRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **fTSIndex** | [**FTSIndex**](FTSIndex.md) | Details to update on the Atlas Search index. | + +### Return type + +[**FTSIndex**](FTSIndex.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/AuditLog.md b/docs/docs/AuditLog.md new file mode 100644 index 00000000..7baa68c2 --- /dev/null +++ b/docs/docs/AuditLog.md @@ -0,0 +1,119 @@ +# AuditLog + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuditAuthorizationSuccess** | **bool** | Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance. | [default to false] +**AuditFilter** | **string** | JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`). | +**ConfigurationType** | Pointer to **string** | Human-readable label that displays how to configure the audit filter. | [optional] [readonly] +**Enabled** | **bool** | Flag that indicates whether someone enabled database auditing for the specified project. | [default to false] + +## Methods + +### NewAuditLog + +`func NewAuditLog(auditAuthorizationSuccess bool, auditFilter string, enabled bool, ) *AuditLog` + +NewAuditLog instantiates a new AuditLog object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAuditLogWithDefaults + +`func NewAuditLogWithDefaults() *AuditLog` + +NewAuditLogWithDefaults instantiates a new AuditLog object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAuditAuthorizationSuccess + +`func (o *AuditLog) GetAuditAuthorizationSuccess() bool` + +GetAuditAuthorizationSuccess returns the AuditAuthorizationSuccess field if non-nil, zero value otherwise. + +### GetAuditAuthorizationSuccessOk + +`func (o *AuditLog) GetAuditAuthorizationSuccessOk() (*bool, bool)` + +GetAuditAuthorizationSuccessOk returns a tuple with the AuditAuthorizationSuccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditAuthorizationSuccess + +`func (o *AuditLog) SetAuditAuthorizationSuccess(v bool)` + +SetAuditAuthorizationSuccess sets AuditAuthorizationSuccess field to given value. + + +### GetAuditFilter + +`func (o *AuditLog) GetAuditFilter() string` + +GetAuditFilter returns the AuditFilter field if non-nil, zero value otherwise. + +### GetAuditFilterOk + +`func (o *AuditLog) GetAuditFilterOk() (*string, bool)` + +GetAuditFilterOk returns a tuple with the AuditFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditFilter + +`func (o *AuditLog) SetAuditFilter(v string)` + +SetAuditFilter sets AuditFilter field to given value. + + +### GetConfigurationType + +`func (o *AuditLog) GetConfigurationType() string` + +GetConfigurationType returns the ConfigurationType field if non-nil, zero value otherwise. + +### GetConfigurationTypeOk + +`func (o *AuditLog) GetConfigurationTypeOk() (*string, bool)` + +GetConfigurationTypeOk returns a tuple with the ConfigurationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigurationType + +`func (o *AuditLog) SetConfigurationType(v string)` + +SetConfigurationType sets ConfigurationType field to given value. + +### HasConfigurationType + +`func (o *AuditLog) HasConfigurationType() bool` + +HasConfigurationType returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AuditLog) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AuditLog) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AuditLog) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AuditingApi.md b/docs/docs/AuditingApi.md new file mode 100644 index 00000000..c4c2b0cc --- /dev/null +++ b/docs/docs/AuditingApi.md @@ -0,0 +1,160 @@ +# \AuditingApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetAuditingConfiguration**](AuditingApi.md#GetAuditingConfiguration) | **Get** /api/atlas/v2/groups/{groupId}/auditLog | Return the Auditing Configuration for One Project +[**UpdateAuditingConfiguration**](AuditingApi.md#UpdateAuditingConfiguration) | **Patch** /api/atlas/v2/groups/{groupId}/auditLog | Update Auditing Configuration for One Project + + + +## GetAuditingConfiguration + +> AuditLog GetAuditingConfiguration(ctx, groupId).Execute() + +Return the Auditing Configuration for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.AuditingApi.GetAuditingConfiguration(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuditingApi.GetAuditingConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetAuditingConfiguration`: AuditLog + fmt.Fprintf(os.Stdout, "Response from `AuditingApi.GetAuditingConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuditingConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AuditLog**](AuditLog.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateAuditingConfiguration + +> AuditLog UpdateAuditingConfiguration(ctx, groupId).AuditLog(auditLog).Execute() + +Update Auditing Configuration for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + auditLog := *openapiclient.NewAuditLog(false, "AuditFilter_example", false) // AuditLog | + + resp, r, err := sdk.AuditingApi.UpdateAuditingConfiguration(context.Background(), groupId).AuditLog(auditLog).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuditingApi.UpdateAuditingConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateAuditingConfiguration`: AuditLog + fmt.Fprintf(os.Stdout, "Response from `AuditingApi.UpdateAuditingConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAuditingConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **auditLog** | [**AuditLog**](AuditLog.md) | Updated auditing configuration for the specified project. | + +### Return type + +[**AuditLog**](AuditLog.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/AutoExportPolicy.md b/docs/docs/AutoExportPolicy.md new file mode 100644 index 00000000..fc30a7e4 --- /dev/null +++ b/docs/docs/AutoExportPolicy.md @@ -0,0 +1,82 @@ +# AutoExportPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExportBucketId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the AWS Bucket. | [optional] +**FrequencyType** | Pointer to **string** | Human-readable label that indicates the rate at which the export policy item occurs. | [optional] + +## Methods + +### NewAutoExportPolicy + +`func NewAutoExportPolicy() *AutoExportPolicy` + +NewAutoExportPolicy instantiates a new AutoExportPolicy object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAutoExportPolicyWithDefaults + +`func NewAutoExportPolicyWithDefaults() *AutoExportPolicy` + +NewAutoExportPolicyWithDefaults instantiates a new AutoExportPolicy object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetExportBucketId + +`func (o *AutoExportPolicy) GetExportBucketId() string` + +GetExportBucketId returns the ExportBucketId field if non-nil, zero value otherwise. + +### GetExportBucketIdOk + +`func (o *AutoExportPolicy) GetExportBucketIdOk() (*string, bool)` + +GetExportBucketIdOk returns a tuple with the ExportBucketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportBucketId + +`func (o *AutoExportPolicy) SetExportBucketId(v string)` + +SetExportBucketId sets ExportBucketId field to given value. + +### HasExportBucketId + +`func (o *AutoExportPolicy) HasExportBucketId() bool` + +HasExportBucketId returns a boolean if a field has been set. + +### GetFrequencyType + +`func (o *AutoExportPolicy) GetFrequencyType() string` + +GetFrequencyType returns the FrequencyType field if non-nil, zero value otherwise. + +### GetFrequencyTypeOk + +`func (o *AutoExportPolicy) GetFrequencyTypeOk() (*string, bool)` + +GetFrequencyTypeOk returns a tuple with the FrequencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencyType + +`func (o *AutoExportPolicy) SetFrequencyType(v string)` + +SetFrequencyType sets FrequencyType field to given value. + +### HasFrequencyType + +`func (o *AutoExportPolicy) HasFrequencyType() bool` + +HasFrequencyType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AutoScaling.md b/docs/docs/AutoScaling.md new file mode 100644 index 00000000..6201fffa --- /dev/null +++ b/docs/docs/AutoScaling.md @@ -0,0 +1,82 @@ +# AutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Compute** | Pointer to [**ComputeAutoScaling**](ComputeAutoScaling.md) | | [optional] +**DiskGBEnabled** | Pointer to **bool** | Flag that indicates whether someone enabled disk auto-scaling for this cluster. | [optional] + +## Methods + +### NewAutoScaling + +`func NewAutoScaling() *AutoScaling` + +NewAutoScaling instantiates a new AutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAutoScalingWithDefaults + +`func NewAutoScalingWithDefaults() *AutoScaling` + +NewAutoScalingWithDefaults instantiates a new AutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCompute + +`func (o *AutoScaling) GetCompute() ComputeAutoScaling` + +GetCompute returns the Compute field if non-nil, zero value otherwise. + +### GetComputeOk + +`func (o *AutoScaling) GetComputeOk() (*ComputeAutoScaling, bool)` + +GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompute + +`func (o *AutoScaling) SetCompute(v ComputeAutoScaling)` + +SetCompute sets Compute field to given value. + +### HasCompute + +`func (o *AutoScaling) HasCompute() bool` + +HasCompute returns a boolean if a field has been set. + +### GetDiskGBEnabled + +`func (o *AutoScaling) GetDiskGBEnabled() bool` + +GetDiskGBEnabled returns the DiskGBEnabled field if non-nil, zero value otherwise. + +### GetDiskGBEnabledOk + +`func (o *AutoScaling) GetDiskGBEnabledOk() (*bool, bool)` + +GetDiskGBEnabledOk returns a tuple with the DiskGBEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskGBEnabled + +`func (o *AutoScaling) SetDiskGBEnabled(v bool)` + +SetDiskGBEnabled sets DiskGBEnabled field to given value. + +### HasDiskGBEnabled + +`func (o *AutoScaling) HasDiskGBEnabled() bool` + +HasDiskGBEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AutoScalingV15.md b/docs/docs/AutoScalingV15.md new file mode 100644 index 00000000..0b94972b --- /dev/null +++ b/docs/docs/AutoScalingV15.md @@ -0,0 +1,82 @@ +# AutoScalingV15 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Compute** | Pointer to [**ComputeAutoScalingV15**](ComputeAutoScalingV15.md) | | [optional] +**DiskGB** | Pointer to [**DiskGBAutoScaling**](DiskGBAutoScaling.md) | | [optional] + +## Methods + +### NewAutoScalingV15 + +`func NewAutoScalingV15() *AutoScalingV15` + +NewAutoScalingV15 instantiates a new AutoScalingV15 object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAutoScalingV15WithDefaults + +`func NewAutoScalingV15WithDefaults() *AutoScalingV15` + +NewAutoScalingV15WithDefaults instantiates a new AutoScalingV15 object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCompute + +`func (o *AutoScalingV15) GetCompute() ComputeAutoScalingV15` + +GetCompute returns the Compute field if non-nil, zero value otherwise. + +### GetComputeOk + +`func (o *AutoScalingV15) GetComputeOk() (*ComputeAutoScalingV15, bool)` + +GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompute + +`func (o *AutoScalingV15) SetCompute(v ComputeAutoScalingV15)` + +SetCompute sets Compute field to given value. + +### HasCompute + +`func (o *AutoScalingV15) HasCompute() bool` + +HasCompute returns a boolean if a field has been set. + +### GetDiskGB + +`func (o *AutoScalingV15) GetDiskGB() DiskGBAutoScaling` + +GetDiskGB returns the DiskGB field if non-nil, zero value otherwise. + +### GetDiskGBOk + +`func (o *AutoScalingV15) GetDiskGBOk() (*DiskGBAutoScaling, bool)` + +GetDiskGBOk returns a tuple with the DiskGB field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskGB + +`func (o *AutoScalingV15) SetDiskGB(v DiskGBAutoScaling)` + +SetDiskGB sets DiskGB field to given value. + +### HasDiskGB + +`func (o *AutoScalingV15) HasDiskGB() bool` + +HasDiskGB returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AutomationConfigEvent.md b/docs/docs/AutomationConfigEvent.md new file mode 100644 index 00000000..48bf8273 --- /dev/null +++ b/docs/docs/AutomationConfigEvent.md @@ -0,0 +1,353 @@ +# AutomationConfigEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**AutomationConfigEventType**](AutomationConfigEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewAutomationConfigEvent + +`func NewAutomationConfigEvent(created time.Time, eventTypeName AutomationConfigEventType, id string, ) *AutomationConfigEvent` + +NewAutomationConfigEvent instantiates a new AutomationConfigEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAutomationConfigEventWithDefaults + +`func NewAutomationConfigEventWithDefaults() *AutomationConfigEvent` + +NewAutomationConfigEventWithDefaults instantiates a new AutomationConfigEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *AutomationConfigEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *AutomationConfigEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *AutomationConfigEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *AutomationConfigEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *AutomationConfigEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AutomationConfigEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AutomationConfigEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *AutomationConfigEvent) GetEventTypeName() AutomationConfigEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *AutomationConfigEvent) GetEventTypeNameOk() (*AutomationConfigEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *AutomationConfigEvent) SetEventTypeName(v AutomationConfigEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *AutomationConfigEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *AutomationConfigEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *AutomationConfigEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *AutomationConfigEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *AutomationConfigEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AutomationConfigEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AutomationConfigEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *AutomationConfigEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *AutomationConfigEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *AutomationConfigEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *AutomationConfigEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *AutomationConfigEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *AutomationConfigEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *AutomationConfigEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *AutomationConfigEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *AutomationConfigEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *AutomationConfigEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *AutomationConfigEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *AutomationConfigEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *AutomationConfigEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *AutomationConfigEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *AutomationConfigEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *AutomationConfigEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *AutomationConfigEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *AutomationConfigEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *AutomationConfigEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *AutomationConfigEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *AutomationConfigEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *AutomationConfigEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *AutomationConfigEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *AutomationConfigEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *AutomationConfigEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *AutomationConfigEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *AutomationConfigEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *AutomationConfigEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *AutomationConfigEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *AutomationConfigEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *AutomationConfigEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *AutomationConfigEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AutomationConfigEventType.md b/docs/docs/AutomationConfigEventType.md new file mode 100644 index 00000000..33d2b112 --- /dev/null +++ b/docs/docs/AutomationConfigEventType.md @@ -0,0 +1,11 @@ +# AutomationConfigEventType + +## Enum + + +* `AUTOMATION_CONFIG_PUBLISHED_AUDIT` (value: `"AUTOMATION_CONFIG_PUBLISHED_AUDIT"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AvailableDeployment.md b/docs/docs/AvailableDeployment.md new file mode 100644 index 00000000..c58bad82 --- /dev/null +++ b/docs/docs/AvailableDeployment.md @@ -0,0 +1,286 @@ +# AvailableDeployment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AgentVersion** | Pointer to **string** | Version of MongoDB Agent that monitors/manages the cluster. | [optional] [readonly] +**ClusterId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the cluster. | [optional] [readonly] +**DbSizeBytes** | Pointer to **int64** | Size of this database on disk at the time of the request expressed in bytes. | [optional] [readonly] +**FeatureCompatibilityVersion** | **string** | Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports. | [readonly] +**Managed** | **bool** | Flag that indicates whether Automation manages this cluster. | [readonly] +**MongoDBVersion** | **string** | Version of MongoDB that this cluster runs. | [readonly] +**Name** | **string** | Human-readable label that identifies this cluster. | [readonly] +**OplogSizeMB** | Pointer to **int** | Size of the Oplog on disk at the time of the request expressed in MB. | [optional] [readonly] +**Sharded** | **bool** | Flag that indicates whether someone configured this cluster as a sharded cluster. - If `true`, this cluster serves as a sharded cluster. - If `false`, this cluster serves as a replica set. | [readonly] +**ShardsSize** | Pointer to **int** | Number of shards that comprise this cluster. | [optional] [readonly] +**TlsEnabled** | **bool** | Flag that indicates whether someone enabled TLS for this cluster. | [readonly] + +## Methods + +### NewAvailableDeployment + +`func NewAvailableDeployment(featureCompatibilityVersion string, managed bool, mongoDBVersion string, name string, sharded bool, tlsEnabled bool, ) *AvailableDeployment` + +NewAvailableDeployment instantiates a new AvailableDeployment object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAvailableDeploymentWithDefaults + +`func NewAvailableDeploymentWithDefaults() *AvailableDeployment` + +NewAvailableDeploymentWithDefaults instantiates a new AvailableDeployment object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAgentVersion + +`func (o *AvailableDeployment) GetAgentVersion() string` + +GetAgentVersion returns the AgentVersion field if non-nil, zero value otherwise. + +### GetAgentVersionOk + +`func (o *AvailableDeployment) GetAgentVersionOk() (*string, bool)` + +GetAgentVersionOk returns a tuple with the AgentVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAgentVersion + +`func (o *AvailableDeployment) SetAgentVersion(v string)` + +SetAgentVersion sets AgentVersion field to given value. + +### HasAgentVersion + +`func (o *AvailableDeployment) HasAgentVersion() bool` + +HasAgentVersion returns a boolean if a field has been set. + +### GetClusterId + +`func (o *AvailableDeployment) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *AvailableDeployment) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *AvailableDeployment) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + +### HasClusterId + +`func (o *AvailableDeployment) HasClusterId() bool` + +HasClusterId returns a boolean if a field has been set. + +### GetDbSizeBytes + +`func (o *AvailableDeployment) GetDbSizeBytes() int64` + +GetDbSizeBytes returns the DbSizeBytes field if non-nil, zero value otherwise. + +### GetDbSizeBytesOk + +`func (o *AvailableDeployment) GetDbSizeBytesOk() (*int64, bool)` + +GetDbSizeBytesOk returns a tuple with the DbSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDbSizeBytes + +`func (o *AvailableDeployment) SetDbSizeBytes(v int64)` + +SetDbSizeBytes sets DbSizeBytes field to given value. + +### HasDbSizeBytes + +`func (o *AvailableDeployment) HasDbSizeBytes() bool` + +HasDbSizeBytes returns a boolean if a field has been set. + +### GetFeatureCompatibilityVersion + +`func (o *AvailableDeployment) GetFeatureCompatibilityVersion() string` + +GetFeatureCompatibilityVersion returns the FeatureCompatibilityVersion field if non-nil, zero value otherwise. + +### GetFeatureCompatibilityVersionOk + +`func (o *AvailableDeployment) GetFeatureCompatibilityVersionOk() (*string, bool)` + +GetFeatureCompatibilityVersionOk returns a tuple with the FeatureCompatibilityVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureCompatibilityVersion + +`func (o *AvailableDeployment) SetFeatureCompatibilityVersion(v string)` + +SetFeatureCompatibilityVersion sets FeatureCompatibilityVersion field to given value. + + +### GetManaged + +`func (o *AvailableDeployment) GetManaged() bool` + +GetManaged returns the Managed field if non-nil, zero value otherwise. + +### GetManagedOk + +`func (o *AvailableDeployment) GetManagedOk() (*bool, bool)` + +GetManagedOk returns a tuple with the Managed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManaged + +`func (o *AvailableDeployment) SetManaged(v bool)` + +SetManaged sets Managed field to given value. + + +### GetMongoDBVersion + +`func (o *AvailableDeployment) GetMongoDBVersion() string` + +GetMongoDBVersion returns the MongoDBVersion field if non-nil, zero value otherwise. + +### GetMongoDBVersionOk + +`func (o *AvailableDeployment) GetMongoDBVersionOk() (*string, bool)` + +GetMongoDBVersionOk returns a tuple with the MongoDBVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoDBVersion + +`func (o *AvailableDeployment) SetMongoDBVersion(v string)` + +SetMongoDBVersion sets MongoDBVersion field to given value. + + +### GetName + +`func (o *AvailableDeployment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AvailableDeployment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AvailableDeployment) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOplogSizeMB + +`func (o *AvailableDeployment) GetOplogSizeMB() int` + +GetOplogSizeMB returns the OplogSizeMB field if non-nil, zero value otherwise. + +### GetOplogSizeMBOk + +`func (o *AvailableDeployment) GetOplogSizeMBOk() (*int, bool)` + +GetOplogSizeMBOk returns a tuple with the OplogSizeMB field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogSizeMB + +`func (o *AvailableDeployment) SetOplogSizeMB(v int)` + +SetOplogSizeMB sets OplogSizeMB field to given value. + +### HasOplogSizeMB + +`func (o *AvailableDeployment) HasOplogSizeMB() bool` + +HasOplogSizeMB returns a boolean if a field has been set. + +### GetSharded + +`func (o *AvailableDeployment) GetSharded() bool` + +GetSharded returns the Sharded field if non-nil, zero value otherwise. + +### GetShardedOk + +`func (o *AvailableDeployment) GetShardedOk() (*bool, bool)` + +GetShardedOk returns a tuple with the Sharded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSharded + +`func (o *AvailableDeployment) SetSharded(v bool)` + +SetSharded sets Sharded field to given value. + + +### GetShardsSize + +`func (o *AvailableDeployment) GetShardsSize() int` + +GetShardsSize returns the ShardsSize field if non-nil, zero value otherwise. + +### GetShardsSizeOk + +`func (o *AvailableDeployment) GetShardsSizeOk() (*int, bool)` + +GetShardsSizeOk returns a tuple with the ShardsSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardsSize + +`func (o *AvailableDeployment) SetShardsSize(v int)` + +SetShardsSize sets ShardsSize field to given value. + +### HasShardsSize + +`func (o *AvailableDeployment) HasShardsSize() bool` + +HasShardsSize returns a boolean if a field has been set. + +### GetTlsEnabled + +`func (o *AvailableDeployment) GetTlsEnabled() bool` + +GetTlsEnabled returns the TlsEnabled field if non-nil, zero value otherwise. + +### GetTlsEnabledOk + +`func (o *AvailableDeployment) GetTlsEnabledOk() (*bool, bool)` + +GetTlsEnabledOk returns a tuple with the TlsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTlsEnabled + +`func (o *AvailableDeployment) SetTlsEnabled(v bool)` + +SetTlsEnabled sets TlsEnabled field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AvailableProject.md b/docs/docs/AvailableProject.md new file mode 100644 index 00000000..d4dec4f8 --- /dev/null +++ b/docs/docs/AvailableProject.md @@ -0,0 +1,124 @@ +# AvailableProject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Deployments** | Pointer to [**[]AvailableDeployment**](AvailableDeployment.md) | List of clusters that can be migrated to MongoDB Cloud. | [optional] +**MigrationHosts** | Pointer to **[]string** | Hostname of MongoDB Agent list that you configured to perform a migration. | [optional] +**Name** | **string** | Human-readable label that identifies this project. | [readonly] +**ProjectId** | **string** | Unique 24-hexadecimal digit string that identifies the project to be migrated. | [readonly] + +## Methods + +### NewAvailableProject + +`func NewAvailableProject(name string, projectId string, ) *AvailableProject` + +NewAvailableProject instantiates a new AvailableProject object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAvailableProjectWithDefaults + +`func NewAvailableProjectWithDefaults() *AvailableProject` + +NewAvailableProjectWithDefaults instantiates a new AvailableProject object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDeployments + +`func (o *AvailableProject) GetDeployments() []AvailableDeployment` + +GetDeployments returns the Deployments field if non-nil, zero value otherwise. + +### GetDeploymentsOk + +`func (o *AvailableProject) GetDeploymentsOk() (*[]AvailableDeployment, bool)` + +GetDeploymentsOk returns a tuple with the Deployments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeployments + +`func (o *AvailableProject) SetDeployments(v []AvailableDeployment)` + +SetDeployments sets Deployments field to given value. + +### HasDeployments + +`func (o *AvailableProject) HasDeployments() bool` + +HasDeployments returns a boolean if a field has been set. + +### GetMigrationHosts + +`func (o *AvailableProject) GetMigrationHosts() []string` + +GetMigrationHosts returns the MigrationHosts field if non-nil, zero value otherwise. + +### GetMigrationHostsOk + +`func (o *AvailableProject) GetMigrationHostsOk() (*[]string, bool)` + +GetMigrationHostsOk returns a tuple with the MigrationHosts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMigrationHosts + +`func (o *AvailableProject) SetMigrationHosts(v []string)` + +SetMigrationHosts sets MigrationHosts field to given value. + +### HasMigrationHosts + +`func (o *AvailableProject) HasMigrationHosts() bool` + +HasMigrationHosts returns a boolean if a field has been set. + +### GetName + +`func (o *AvailableProject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AvailableProject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AvailableProject) SetName(v string)` + +SetName sets Name field to given value. + + +### GetProjectId + +`func (o *AvailableProject) GetProjectId() string` + +GetProjectId returns the ProjectId field if non-nil, zero value otherwise. + +### GetProjectIdOk + +`func (o *AvailableProject) GetProjectIdOk() (*string, bool)` + +GetProjectIdOk returns a tuple with the ProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProjectId + +`func (o *AvailableProject) SetProjectId(v string)` + +SetProjectId sets ProjectId field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AvailableRegion.md b/docs/docs/AvailableRegion.md new file mode 100644 index 00000000..ee575cd2 --- /dev/null +++ b/docs/docs/AvailableRegion.md @@ -0,0 +1,82 @@ +# AvailableRegion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Default** | Pointer to **bool** | Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the supported region. | [optional] [readonly] + +## Methods + +### NewAvailableRegion + +`func NewAvailableRegion() *AvailableRegion` + +NewAvailableRegion instantiates a new AvailableRegion object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAvailableRegionWithDefaults + +`func NewAvailableRegionWithDefaults() *AvailableRegion` + +NewAvailableRegionWithDefaults instantiates a new AvailableRegion object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDefault + +`func (o *AvailableRegion) GetDefault() bool` + +GetDefault returns the Default field if non-nil, zero value otherwise. + +### GetDefaultOk + +`func (o *AvailableRegion) GetDefaultOk() (*bool, bool)` + +GetDefaultOk returns a tuple with the Default field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefault + +`func (o *AvailableRegion) SetDefault(v bool)` + +SetDefault sets Default field to given value. + +### HasDefault + +`func (o *AvailableRegion) HasDefault() bool` + +HasDefault returns a boolean if a field has been set. + +### GetName + +`func (o *AvailableRegion) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AvailableRegion) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AvailableRegion) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AvailableRegion) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzureAutoScaling.md b/docs/docs/AzureAutoScaling.md new file mode 100644 index 00000000..7d577eb4 --- /dev/null +++ b/docs/docs/AzureAutoScaling.md @@ -0,0 +1,56 @@ +# AzureAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Compute** | Pointer to [**AzureComputeAutoScaling**](AzureComputeAutoScaling.md) | | [optional] + +## Methods + +### NewAzureAutoScaling + +`func NewAzureAutoScaling() *AzureAutoScaling` + +NewAzureAutoScaling instantiates a new AzureAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzureAutoScalingWithDefaults + +`func NewAzureAutoScalingWithDefaults() *AzureAutoScaling` + +NewAzureAutoScalingWithDefaults instantiates a new AzureAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCompute + +`func (o *AzureAutoScaling) GetCompute() AzureComputeAutoScaling` + +GetCompute returns the Compute field if non-nil, zero value otherwise. + +### GetComputeOk + +`func (o *AzureAutoScaling) GetComputeOk() (*AzureComputeAutoScaling, bool)` + +GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompute + +`func (o *AzureAutoScaling) SetCompute(v AzureComputeAutoScaling)` + +SetCompute sets Compute field to given value. + +### HasCompute + +`func (o *AzureAutoScaling) HasCompute() bool` + +HasCompute returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzureCloudProviderContainer.md b/docs/docs/AzureCloudProviderContainer.md new file mode 100644 index 00000000..781e93de --- /dev/null +++ b/docs/docs/AzureCloudProviderContainer.md @@ -0,0 +1,202 @@ +# AzureCloudProviderContainer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AtlasCidrBlock** | **string** | IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. | +**AzureSubscriptionId** | Pointer to **string** | Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides. | [optional] [readonly] +**Region** | **string** | Azure region to which MongoDB Cloud deployed this network peering container. | +**VnetName** | Pointer to **string** | Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering container. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering containers. | [optional] +**Provisioned** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. | [optional] [readonly] + +## Methods + +### NewAzureCloudProviderContainer + +`func NewAzureCloudProviderContainer(atlasCidrBlock string, region string, ) *AzureCloudProviderContainer` + +NewAzureCloudProviderContainer instantiates a new AzureCloudProviderContainer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzureCloudProviderContainerWithDefaults + +`func NewAzureCloudProviderContainerWithDefaults() *AzureCloudProviderContainer` + +NewAzureCloudProviderContainerWithDefaults instantiates a new AzureCloudProviderContainer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAtlasCidrBlock + +`func (o *AzureCloudProviderContainer) GetAtlasCidrBlock() string` + +GetAtlasCidrBlock returns the AtlasCidrBlock field if non-nil, zero value otherwise. + +### GetAtlasCidrBlockOk + +`func (o *AzureCloudProviderContainer) GetAtlasCidrBlockOk() (*string, bool)` + +GetAtlasCidrBlockOk returns a tuple with the AtlasCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasCidrBlock + +`func (o *AzureCloudProviderContainer) SetAtlasCidrBlock(v string)` + +SetAtlasCidrBlock sets AtlasCidrBlock field to given value. + + +### GetAzureSubscriptionId + +`func (o *AzureCloudProviderContainer) GetAzureSubscriptionId() string` + +GetAzureSubscriptionId returns the AzureSubscriptionId field if non-nil, zero value otherwise. + +### GetAzureSubscriptionIdOk + +`func (o *AzureCloudProviderContainer) GetAzureSubscriptionIdOk() (*string, bool)` + +GetAzureSubscriptionIdOk returns a tuple with the AzureSubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureSubscriptionId + +`func (o *AzureCloudProviderContainer) SetAzureSubscriptionId(v string)` + +SetAzureSubscriptionId sets AzureSubscriptionId field to given value. + +### HasAzureSubscriptionId + +`func (o *AzureCloudProviderContainer) HasAzureSubscriptionId() bool` + +HasAzureSubscriptionId returns a boolean if a field has been set. + +### GetRegion + +`func (o *AzureCloudProviderContainer) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *AzureCloudProviderContainer) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *AzureCloudProviderContainer) SetRegion(v string)` + +SetRegion sets Region field to given value. + + +### GetVnetName + +`func (o *AzureCloudProviderContainer) GetVnetName() string` + +GetVnetName returns the VnetName field if non-nil, zero value otherwise. + +### GetVnetNameOk + +`func (o *AzureCloudProviderContainer) GetVnetNameOk() (*string, bool)` + +GetVnetNameOk returns a tuple with the VnetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVnetName + +`func (o *AzureCloudProviderContainer) SetVnetName(v string)` + +SetVnetName sets VnetName field to given value. + +### HasVnetName + +`func (o *AzureCloudProviderContainer) HasVnetName() bool` + +HasVnetName returns a boolean if a field has been set. + +### GetId + +`func (o *AzureCloudProviderContainer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AzureCloudProviderContainer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AzureCloudProviderContainer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AzureCloudProviderContainer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AzureCloudProviderContainer) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AzureCloudProviderContainer) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AzureCloudProviderContainer) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *AzureCloudProviderContainer) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetProvisioned + +`func (o *AzureCloudProviderContainer) GetProvisioned() bool` + +GetProvisioned returns the Provisioned field if non-nil, zero value otherwise. + +### GetProvisionedOk + +`func (o *AzureCloudProviderContainer) GetProvisionedOk() (*bool, bool)` + +GetProvisionedOk returns a tuple with the Provisioned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioned + +`func (o *AzureCloudProviderContainer) SetProvisioned(v bool)` + +SetProvisioned sets Provisioned field to given value. + +### HasProvisioned + +`func (o *AzureCloudProviderContainer) HasProvisioned() bool` + +HasProvisioned returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzureComputeAutoScaling.md b/docs/docs/AzureComputeAutoScaling.md new file mode 100644 index 00000000..426d39c6 --- /dev/null +++ b/docs/docs/AzureComputeAutoScaling.md @@ -0,0 +1,82 @@ +# AzureComputeAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxInstanceSize** | Pointer to **string** | Maximum instance size to which your cluster can automatically scale. | [optional] +**MinInstanceSize** | Pointer to **string** | Minimum instance size to which your cluster can automatically scale. | [optional] + +## Methods + +### NewAzureComputeAutoScaling + +`func NewAzureComputeAutoScaling() *AzureComputeAutoScaling` + +NewAzureComputeAutoScaling instantiates a new AzureComputeAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzureComputeAutoScalingWithDefaults + +`func NewAzureComputeAutoScalingWithDefaults() *AzureComputeAutoScaling` + +NewAzureComputeAutoScalingWithDefaults instantiates a new AzureComputeAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxInstanceSize + +`func (o *AzureComputeAutoScaling) GetMaxInstanceSize() string` + +GetMaxInstanceSize returns the MaxInstanceSize field if non-nil, zero value otherwise. + +### GetMaxInstanceSizeOk + +`func (o *AzureComputeAutoScaling) GetMaxInstanceSizeOk() (*string, bool)` + +GetMaxInstanceSizeOk returns a tuple with the MaxInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxInstanceSize + +`func (o *AzureComputeAutoScaling) SetMaxInstanceSize(v string)` + +SetMaxInstanceSize sets MaxInstanceSize field to given value. + +### HasMaxInstanceSize + +`func (o *AzureComputeAutoScaling) HasMaxInstanceSize() bool` + +HasMaxInstanceSize returns a boolean if a field has been set. + +### GetMinInstanceSize + +`func (o *AzureComputeAutoScaling) GetMinInstanceSize() string` + +GetMinInstanceSize returns the MinInstanceSize field if non-nil, zero value otherwise. + +### GetMinInstanceSizeOk + +`func (o *AzureComputeAutoScaling) GetMinInstanceSizeOk() (*string, bool)` + +GetMinInstanceSizeOk returns a tuple with the MinInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinInstanceSize + +`func (o *AzureComputeAutoScaling) SetMinInstanceSize(v string)` + +SetMinInstanceSize sets MinInstanceSize field to given value. + +### HasMinInstanceSize + +`func (o *AzureComputeAutoScaling) HasMinInstanceSize() bool` + +HasMinInstanceSize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzureHardwareSpec.md b/docs/docs/AzureHardwareSpec.md new file mode 100644 index 00000000..07dd125f --- /dev/null +++ b/docs/docs/AzureHardwareSpec.md @@ -0,0 +1,82 @@ +# AzureHardwareSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InstanceSize** | Pointer to **string** | Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. | [optional] +**NodeCount** | Pointer to **int** | Number of nodes of the given type for MongoDB Cloud to deploy to the region. | [optional] + +## Methods + +### NewAzureHardwareSpec + +`func NewAzureHardwareSpec() *AzureHardwareSpec` + +NewAzureHardwareSpec instantiates a new AzureHardwareSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzureHardwareSpecWithDefaults + +`func NewAzureHardwareSpecWithDefaults() *AzureHardwareSpec` + +NewAzureHardwareSpecWithDefaults instantiates a new AzureHardwareSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInstanceSize + +`func (o *AzureHardwareSpec) GetInstanceSize() string` + +GetInstanceSize returns the InstanceSize field if non-nil, zero value otherwise. + +### GetInstanceSizeOk + +`func (o *AzureHardwareSpec) GetInstanceSizeOk() (*string, bool)` + +GetInstanceSizeOk returns a tuple with the InstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSize + +`func (o *AzureHardwareSpec) SetInstanceSize(v string)` + +SetInstanceSize sets InstanceSize field to given value. + +### HasInstanceSize + +`func (o *AzureHardwareSpec) HasInstanceSize() bool` + +HasInstanceSize returns a boolean if a field has been set. + +### GetNodeCount + +`func (o *AzureHardwareSpec) GetNodeCount() int` + +GetNodeCount returns the NodeCount field if non-nil, zero value otherwise. + +### GetNodeCountOk + +`func (o *AzureHardwareSpec) GetNodeCountOk() (*int, bool)` + +GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNodeCount + +`func (o *AzureHardwareSpec) SetNodeCount(v int)` + +SetNodeCount sets NodeCount field to given value. + +### HasNodeCount + +`func (o *AzureHardwareSpec) HasNodeCount() bool` + +HasNodeCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzureKeyVault.md b/docs/docs/AzureKeyVault.md new file mode 100644 index 00000000..76e3c5fb --- /dev/null +++ b/docs/docs/AzureKeyVault.md @@ -0,0 +1,290 @@ +# AzureKeyVault + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AzureEnvironment** | Pointer to **string** | Azure environment in which your account credentials reside. | [optional] +**ClientID** | Pointer to **string** | Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant. | [optional] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`. | [optional] +**KeyIdentifier** | Pointer to **string** | Web address with a unique key that identifies for your Azure Key Vault. | [optional] +**KeyVaultName** | Pointer to **string** | Unique string that identifies the Azure Key Vault that contains your key. | [optional] +**ResourceGroupName** | Pointer to **string** | Name of the Azure resource group that contains your Azure Key Vault. | [optional] +**Secret** | Pointer to **string** | Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data. | [optional] +**SubscriptionID** | Pointer to **string** | Unique 36-hexadecimal character string that identifies your Azure subscription. | [optional] +**TenantID** | Pointer to **string** | Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription. | [optional] +**Valid** | Pointer to **bool** | Flag that indicates whether the Azure encryption key can encrypt and decrypt data. | [optional] [readonly] + +## Methods + +### NewAzureKeyVault + +`func NewAzureKeyVault() *AzureKeyVault` + +NewAzureKeyVault instantiates a new AzureKeyVault object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzureKeyVaultWithDefaults + +`func NewAzureKeyVaultWithDefaults() *AzureKeyVault` + +NewAzureKeyVaultWithDefaults instantiates a new AzureKeyVault object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAzureEnvironment + +`func (o *AzureKeyVault) GetAzureEnvironment() string` + +GetAzureEnvironment returns the AzureEnvironment field if non-nil, zero value otherwise. + +### GetAzureEnvironmentOk + +`func (o *AzureKeyVault) GetAzureEnvironmentOk() (*string, bool)` + +GetAzureEnvironmentOk returns a tuple with the AzureEnvironment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureEnvironment + +`func (o *AzureKeyVault) SetAzureEnvironment(v string)` + +SetAzureEnvironment sets AzureEnvironment field to given value. + +### HasAzureEnvironment + +`func (o *AzureKeyVault) HasAzureEnvironment() bool` + +HasAzureEnvironment returns a boolean if a field has been set. + +### GetClientID + +`func (o *AzureKeyVault) GetClientID() string` + +GetClientID returns the ClientID field if non-nil, zero value otherwise. + +### GetClientIDOk + +`func (o *AzureKeyVault) GetClientIDOk() (*string, bool)` + +GetClientIDOk returns a tuple with the ClientID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientID + +`func (o *AzureKeyVault) SetClientID(v string)` + +SetClientID sets ClientID field to given value. + +### HasClientID + +`func (o *AzureKeyVault) HasClientID() bool` + +HasClientID returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AzureKeyVault) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AzureKeyVault) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AzureKeyVault) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AzureKeyVault) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetKeyIdentifier + +`func (o *AzureKeyVault) GetKeyIdentifier() string` + +GetKeyIdentifier returns the KeyIdentifier field if non-nil, zero value otherwise. + +### GetKeyIdentifierOk + +`func (o *AzureKeyVault) GetKeyIdentifierOk() (*string, bool)` + +GetKeyIdentifierOk returns a tuple with the KeyIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeyIdentifier + +`func (o *AzureKeyVault) SetKeyIdentifier(v string)` + +SetKeyIdentifier sets KeyIdentifier field to given value. + +### HasKeyIdentifier + +`func (o *AzureKeyVault) HasKeyIdentifier() bool` + +HasKeyIdentifier returns a boolean if a field has been set. + +### GetKeyVaultName + +`func (o *AzureKeyVault) GetKeyVaultName() string` + +GetKeyVaultName returns the KeyVaultName field if non-nil, zero value otherwise. + +### GetKeyVaultNameOk + +`func (o *AzureKeyVault) GetKeyVaultNameOk() (*string, bool)` + +GetKeyVaultNameOk returns a tuple with the KeyVaultName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeyVaultName + +`func (o *AzureKeyVault) SetKeyVaultName(v string)` + +SetKeyVaultName sets KeyVaultName field to given value. + +### HasKeyVaultName + +`func (o *AzureKeyVault) HasKeyVaultName() bool` + +HasKeyVaultName returns a boolean if a field has been set. + +### GetResourceGroupName + +`func (o *AzureKeyVault) GetResourceGroupName() string` + +GetResourceGroupName returns the ResourceGroupName field if non-nil, zero value otherwise. + +### GetResourceGroupNameOk + +`func (o *AzureKeyVault) GetResourceGroupNameOk() (*string, bool)` + +GetResourceGroupNameOk returns a tuple with the ResourceGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceGroupName + +`func (o *AzureKeyVault) SetResourceGroupName(v string)` + +SetResourceGroupName sets ResourceGroupName field to given value. + +### HasResourceGroupName + +`func (o *AzureKeyVault) HasResourceGroupName() bool` + +HasResourceGroupName returns a boolean if a field has been set. + +### GetSecret + +`func (o *AzureKeyVault) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *AzureKeyVault) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *AzureKeyVault) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *AzureKeyVault) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetSubscriptionID + +`func (o *AzureKeyVault) GetSubscriptionID() string` + +GetSubscriptionID returns the SubscriptionID field if non-nil, zero value otherwise. + +### GetSubscriptionIDOk + +`func (o *AzureKeyVault) GetSubscriptionIDOk() (*string, bool)` + +GetSubscriptionIDOk returns a tuple with the SubscriptionID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionID + +`func (o *AzureKeyVault) SetSubscriptionID(v string)` + +SetSubscriptionID sets SubscriptionID field to given value. + +### HasSubscriptionID + +`func (o *AzureKeyVault) HasSubscriptionID() bool` + +HasSubscriptionID returns a boolean if a field has been set. + +### GetTenantID + +`func (o *AzureKeyVault) GetTenantID() string` + +GetTenantID returns the TenantID field if non-nil, zero value otherwise. + +### GetTenantIDOk + +`func (o *AzureKeyVault) GetTenantIDOk() (*string, bool)` + +GetTenantIDOk returns a tuple with the TenantID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantID + +`func (o *AzureKeyVault) SetTenantID(v string)` + +SetTenantID sets TenantID field to given value. + +### HasTenantID + +`func (o *AzureKeyVault) HasTenantID() bool` + +HasTenantID returns a boolean if a field has been set. + +### GetValid + +`func (o *AzureKeyVault) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *AzureKeyVault) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *AzureKeyVault) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *AzureKeyVault) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzurePeerNetwork.md b/docs/docs/AzurePeerNetwork.md new file mode 100644 index 00000000..5626d6bb --- /dev/null +++ b/docs/docs/AzurePeerNetwork.md @@ -0,0 +1,239 @@ +# AzurePeerNetwork + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AzureDirectoryId** | **string** | Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides. | +**AzureSubscriptionId** | **string** | Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides. | +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ErrorState** | Pointer to **string** | Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering connection. | [optional] +**ResourceGroupName** | **string** | Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides. | +**Status** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VnetName** | **string** | Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet. | + +## Methods + +### NewAzurePeerNetwork + +`func NewAzurePeerNetwork(azureDirectoryId string, azureSubscriptionId string, containerId string, resourceGroupName string, vnetName string, ) *AzurePeerNetwork` + +NewAzurePeerNetwork instantiates a new AzurePeerNetwork object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzurePeerNetworkWithDefaults + +`func NewAzurePeerNetworkWithDefaults() *AzurePeerNetwork` + +NewAzurePeerNetworkWithDefaults instantiates a new AzurePeerNetwork object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAzureDirectoryId + +`func (o *AzurePeerNetwork) GetAzureDirectoryId() string` + +GetAzureDirectoryId returns the AzureDirectoryId field if non-nil, zero value otherwise. + +### GetAzureDirectoryIdOk + +`func (o *AzurePeerNetwork) GetAzureDirectoryIdOk() (*string, bool)` + +GetAzureDirectoryIdOk returns a tuple with the AzureDirectoryId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureDirectoryId + +`func (o *AzurePeerNetwork) SetAzureDirectoryId(v string)` + +SetAzureDirectoryId sets AzureDirectoryId field to given value. + + +### GetAzureSubscriptionId + +`func (o *AzurePeerNetwork) GetAzureSubscriptionId() string` + +GetAzureSubscriptionId returns the AzureSubscriptionId field if non-nil, zero value otherwise. + +### GetAzureSubscriptionIdOk + +`func (o *AzurePeerNetwork) GetAzureSubscriptionIdOk() (*string, bool)` + +GetAzureSubscriptionIdOk returns a tuple with the AzureSubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureSubscriptionId + +`func (o *AzurePeerNetwork) SetAzureSubscriptionId(v string)` + +SetAzureSubscriptionId sets AzureSubscriptionId field to given value. + + +### GetContainerId + +`func (o *AzurePeerNetwork) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *AzurePeerNetwork) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *AzurePeerNetwork) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetErrorState + +`func (o *AzurePeerNetwork) GetErrorState() string` + +GetErrorState returns the ErrorState field if non-nil, zero value otherwise. + +### GetErrorStateOk + +`func (o *AzurePeerNetwork) GetErrorStateOk() (*string, bool)` + +GetErrorStateOk returns a tuple with the ErrorState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorState + +`func (o *AzurePeerNetwork) SetErrorState(v string)` + +SetErrorState sets ErrorState field to given value. + +### HasErrorState + +`func (o *AzurePeerNetwork) HasErrorState() bool` + +HasErrorState returns a boolean if a field has been set. + +### GetId + +`func (o *AzurePeerNetwork) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AzurePeerNetwork) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AzurePeerNetwork) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AzurePeerNetwork) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AzurePeerNetwork) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AzurePeerNetwork) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AzurePeerNetwork) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *AzurePeerNetwork) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetResourceGroupName + +`func (o *AzurePeerNetwork) GetResourceGroupName() string` + +GetResourceGroupName returns the ResourceGroupName field if non-nil, zero value otherwise. + +### GetResourceGroupNameOk + +`func (o *AzurePeerNetwork) GetResourceGroupNameOk() (*string, bool)` + +GetResourceGroupNameOk returns a tuple with the ResourceGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceGroupName + +`func (o *AzurePeerNetwork) SetResourceGroupName(v string)` + +SetResourceGroupName sets ResourceGroupName field to given value. + + +### GetStatus + +`func (o *AzurePeerNetwork) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AzurePeerNetwork) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AzurePeerNetwork) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AzurePeerNetwork) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetVnetName + +`func (o *AzurePeerNetwork) GetVnetName() string` + +GetVnetName returns the VnetName field if non-nil, zero value otherwise. + +### GetVnetNameOk + +`func (o *AzurePeerNetwork) GetVnetNameOk() (*string, bool)` + +GetVnetNameOk returns a tuple with the VnetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVnetName + +`func (o *AzurePeerNetwork) SetVnetName(v string)` + +SetVnetName sets VnetName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzurePeerNetworkRequest.md b/docs/docs/AzurePeerNetworkRequest.md new file mode 100644 index 00000000..fa943c49 --- /dev/null +++ b/docs/docs/AzurePeerNetworkRequest.md @@ -0,0 +1,234 @@ +# AzurePeerNetworkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ProviderName** | **string** | Cloud service provider that serves the requested network peering connection. | +**AzureDirectoryId** | **string** | Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides. | +**AzureSubscriptionId** | **string** | Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides. | +**ErrorState** | Pointer to **string** | Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**ResourceGroupName** | **string** | Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides. | +**Status** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VnetName** | **string** | Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet. | + +## Methods + +### NewAzurePeerNetworkRequest + +`func NewAzurePeerNetworkRequest(containerId string, providerName string, azureDirectoryId string, azureSubscriptionId string, resourceGroupName string, vnetName string, ) *AzurePeerNetworkRequest` + +NewAzurePeerNetworkRequest instantiates a new AzurePeerNetworkRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzurePeerNetworkRequestWithDefaults + +`func NewAzurePeerNetworkRequestWithDefaults() *AzurePeerNetworkRequest` + +NewAzurePeerNetworkRequestWithDefaults instantiates a new AzurePeerNetworkRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContainerId + +`func (o *AzurePeerNetworkRequest) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *AzurePeerNetworkRequest) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *AzurePeerNetworkRequest) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetProviderName + +`func (o *AzurePeerNetworkRequest) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AzurePeerNetworkRequest) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AzurePeerNetworkRequest) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetAzureDirectoryId + +`func (o *AzurePeerNetworkRequest) GetAzureDirectoryId() string` + +GetAzureDirectoryId returns the AzureDirectoryId field if non-nil, zero value otherwise. + +### GetAzureDirectoryIdOk + +`func (o *AzurePeerNetworkRequest) GetAzureDirectoryIdOk() (*string, bool)` + +GetAzureDirectoryIdOk returns a tuple with the AzureDirectoryId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureDirectoryId + +`func (o *AzurePeerNetworkRequest) SetAzureDirectoryId(v string)` + +SetAzureDirectoryId sets AzureDirectoryId field to given value. + + +### GetAzureSubscriptionId + +`func (o *AzurePeerNetworkRequest) GetAzureSubscriptionId() string` + +GetAzureSubscriptionId returns the AzureSubscriptionId field if non-nil, zero value otherwise. + +### GetAzureSubscriptionIdOk + +`func (o *AzurePeerNetworkRequest) GetAzureSubscriptionIdOk() (*string, bool)` + +GetAzureSubscriptionIdOk returns a tuple with the AzureSubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureSubscriptionId + +`func (o *AzurePeerNetworkRequest) SetAzureSubscriptionId(v string)` + +SetAzureSubscriptionId sets AzureSubscriptionId field to given value. + + +### GetErrorState + +`func (o *AzurePeerNetworkRequest) GetErrorState() string` + +GetErrorState returns the ErrorState field if non-nil, zero value otherwise. + +### GetErrorStateOk + +`func (o *AzurePeerNetworkRequest) GetErrorStateOk() (*string, bool)` + +GetErrorStateOk returns a tuple with the ErrorState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorState + +`func (o *AzurePeerNetworkRequest) SetErrorState(v string)` + +SetErrorState sets ErrorState field to given value. + +### HasErrorState + +`func (o *AzurePeerNetworkRequest) HasErrorState() bool` + +HasErrorState returns a boolean if a field has been set. + +### GetId + +`func (o *AzurePeerNetworkRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AzurePeerNetworkRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AzurePeerNetworkRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AzurePeerNetworkRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetResourceGroupName + +`func (o *AzurePeerNetworkRequest) GetResourceGroupName() string` + +GetResourceGroupName returns the ResourceGroupName field if non-nil, zero value otherwise. + +### GetResourceGroupNameOk + +`func (o *AzurePeerNetworkRequest) GetResourceGroupNameOk() (*string, bool)` + +GetResourceGroupNameOk returns a tuple with the ResourceGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceGroupName + +`func (o *AzurePeerNetworkRequest) SetResourceGroupName(v string)` + +SetResourceGroupName sets ResourceGroupName field to given value. + + +### GetStatus + +`func (o *AzurePeerNetworkRequest) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AzurePeerNetworkRequest) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AzurePeerNetworkRequest) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AzurePeerNetworkRequest) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetVnetName + +`func (o *AzurePeerNetworkRequest) GetVnetName() string` + +GetVnetName returns the VnetName field if non-nil, zero value otherwise. + +### GetVnetNameOk + +`func (o *AzurePeerNetworkRequest) GetVnetNameOk() (*string, bool)` + +GetVnetNameOk returns a tuple with the VnetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVnetName + +`func (o *AzurePeerNetworkRequest) SetVnetName(v string)` + +SetVnetName sets VnetName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzurePrivateEndpoint.md b/docs/docs/AzurePrivateEndpoint.md new file mode 100644 index 00000000..98090a79 --- /dev/null +++ b/docs/docs/AzurePrivateEndpoint.md @@ -0,0 +1,186 @@ +# AzurePrivateEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DeleteRequested** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**PrivateEndpointConnectionName** | Pointer to **string** | Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection. | [optional] [readonly] +**PrivateEndpointIPAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] +**PrivateEndpointResourceId** | Pointer to **string** | Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service. | [optional] [readonly] +**Status** | Pointer to **string** | State of the Azure Private Link Service connection when MongoDB Cloud received this request. | [optional] [readonly] + +## Methods + +### NewAzurePrivateEndpoint + +`func NewAzurePrivateEndpoint() *AzurePrivateEndpoint` + +NewAzurePrivateEndpoint instantiates a new AzurePrivateEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzurePrivateEndpointWithDefaults + +`func NewAzurePrivateEndpointWithDefaults() *AzurePrivateEndpoint` + +NewAzurePrivateEndpointWithDefaults instantiates a new AzurePrivateEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDeleteRequested + +`func (o *AzurePrivateEndpoint) GetDeleteRequested() bool` + +GetDeleteRequested returns the DeleteRequested field if non-nil, zero value otherwise. + +### GetDeleteRequestedOk + +`func (o *AzurePrivateEndpoint) GetDeleteRequestedOk() (*bool, bool)` + +GetDeleteRequestedOk returns a tuple with the DeleteRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteRequested + +`func (o *AzurePrivateEndpoint) SetDeleteRequested(v bool)` + +SetDeleteRequested sets DeleteRequested field to given value. + +### HasDeleteRequested + +`func (o *AzurePrivateEndpoint) HasDeleteRequested() bool` + +HasDeleteRequested returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *AzurePrivateEndpoint) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *AzurePrivateEndpoint) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *AzurePrivateEndpoint) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *AzurePrivateEndpoint) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetPrivateEndpointConnectionName + +`func (o *AzurePrivateEndpoint) GetPrivateEndpointConnectionName() string` + +GetPrivateEndpointConnectionName returns the PrivateEndpointConnectionName field if non-nil, zero value otherwise. + +### GetPrivateEndpointConnectionNameOk + +`func (o *AzurePrivateEndpoint) GetPrivateEndpointConnectionNameOk() (*string, bool)` + +GetPrivateEndpointConnectionNameOk returns a tuple with the PrivateEndpointConnectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointConnectionName + +`func (o *AzurePrivateEndpoint) SetPrivateEndpointConnectionName(v string)` + +SetPrivateEndpointConnectionName sets PrivateEndpointConnectionName field to given value. + +### HasPrivateEndpointConnectionName + +`func (o *AzurePrivateEndpoint) HasPrivateEndpointConnectionName() bool` + +HasPrivateEndpointConnectionName returns a boolean if a field has been set. + +### GetPrivateEndpointIPAddress + +`func (o *AzurePrivateEndpoint) GetPrivateEndpointIPAddress() string` + +GetPrivateEndpointIPAddress returns the PrivateEndpointIPAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIPAddressOk + +`func (o *AzurePrivateEndpoint) GetPrivateEndpointIPAddressOk() (*string, bool)` + +GetPrivateEndpointIPAddressOk returns a tuple with the PrivateEndpointIPAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIPAddress + +`func (o *AzurePrivateEndpoint) SetPrivateEndpointIPAddress(v string)` + +SetPrivateEndpointIPAddress sets PrivateEndpointIPAddress field to given value. + +### HasPrivateEndpointIPAddress + +`func (o *AzurePrivateEndpoint) HasPrivateEndpointIPAddress() bool` + +HasPrivateEndpointIPAddress returns a boolean if a field has been set. + +### GetPrivateEndpointResourceId + +`func (o *AzurePrivateEndpoint) GetPrivateEndpointResourceId() string` + +GetPrivateEndpointResourceId returns the PrivateEndpointResourceId field if non-nil, zero value otherwise. + +### GetPrivateEndpointResourceIdOk + +`func (o *AzurePrivateEndpoint) GetPrivateEndpointResourceIdOk() (*string, bool)` + +GetPrivateEndpointResourceIdOk returns a tuple with the PrivateEndpointResourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointResourceId + +`func (o *AzurePrivateEndpoint) SetPrivateEndpointResourceId(v string)` + +SetPrivateEndpointResourceId sets PrivateEndpointResourceId field to given value. + +### HasPrivateEndpointResourceId + +`func (o *AzurePrivateEndpoint) HasPrivateEndpointResourceId() bool` + +HasPrivateEndpointResourceId returns a boolean if a field has been set. + +### GetStatus + +`func (o *AzurePrivateEndpoint) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AzurePrivateEndpoint) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AzurePrivateEndpoint) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AzurePrivateEndpoint) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzurePrivateLinkConnection.md b/docs/docs/AzurePrivateLinkConnection.md new file mode 100644 index 00000000..4bbe6ea8 --- /dev/null +++ b/docs/docs/AzurePrivateLinkConnection.md @@ -0,0 +1,212 @@ +# AzurePrivateLinkConnection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. | [optional] [readonly] +**PrivateEndpoints** | Pointer to **[]string** | List of private endpoints assigned to this Azure Private Link Service. | [optional] [readonly] +**PrivateLinkServiceName** | Pointer to **string** | Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages. | [optional] [readonly] +**PrivateLinkServiceResourceId** | Pointer to **string** | Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet. | [optional] [readonly] +**RegionName** | Pointer to **string** | Cloud provider region that manages this Private Endpoint Service. | [optional] [readonly] +**Status** | Pointer to **string** | State of the Private Endpoint Service connection when MongoDB Cloud received this request. | [optional] [readonly] + +## Methods + +### NewAzurePrivateLinkConnection + +`func NewAzurePrivateLinkConnection() *AzurePrivateLinkConnection` + +NewAzurePrivateLinkConnection instantiates a new AzurePrivateLinkConnection object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzurePrivateLinkConnectionWithDefaults + +`func NewAzurePrivateLinkConnectionWithDefaults() *AzurePrivateLinkConnection` + +NewAzurePrivateLinkConnectionWithDefaults instantiates a new AzurePrivateLinkConnection object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetErrorMessage + +`func (o *AzurePrivateLinkConnection) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *AzurePrivateLinkConnection) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *AzurePrivateLinkConnection) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *AzurePrivateLinkConnection) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetId + +`func (o *AzurePrivateLinkConnection) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AzurePrivateLinkConnection) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AzurePrivateLinkConnection) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AzurePrivateLinkConnection) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetPrivateEndpoints + +`func (o *AzurePrivateLinkConnection) GetPrivateEndpoints() []string` + +GetPrivateEndpoints returns the PrivateEndpoints field if non-nil, zero value otherwise. + +### GetPrivateEndpointsOk + +`func (o *AzurePrivateLinkConnection) GetPrivateEndpointsOk() (*[]string, bool)` + +GetPrivateEndpointsOk returns a tuple with the PrivateEndpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpoints + +`func (o *AzurePrivateLinkConnection) SetPrivateEndpoints(v []string)` + +SetPrivateEndpoints sets PrivateEndpoints field to given value. + +### HasPrivateEndpoints + +`func (o *AzurePrivateLinkConnection) HasPrivateEndpoints() bool` + +HasPrivateEndpoints returns a boolean if a field has been set. + +### GetPrivateLinkServiceName + +`func (o *AzurePrivateLinkConnection) GetPrivateLinkServiceName() string` + +GetPrivateLinkServiceName returns the PrivateLinkServiceName field if non-nil, zero value otherwise. + +### GetPrivateLinkServiceNameOk + +`func (o *AzurePrivateLinkConnection) GetPrivateLinkServiceNameOk() (*string, bool)` + +GetPrivateLinkServiceNameOk returns a tuple with the PrivateLinkServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateLinkServiceName + +`func (o *AzurePrivateLinkConnection) SetPrivateLinkServiceName(v string)` + +SetPrivateLinkServiceName sets PrivateLinkServiceName field to given value. + +### HasPrivateLinkServiceName + +`func (o *AzurePrivateLinkConnection) HasPrivateLinkServiceName() bool` + +HasPrivateLinkServiceName returns a boolean if a field has been set. + +### GetPrivateLinkServiceResourceId + +`func (o *AzurePrivateLinkConnection) GetPrivateLinkServiceResourceId() string` + +GetPrivateLinkServiceResourceId returns the PrivateLinkServiceResourceId field if non-nil, zero value otherwise. + +### GetPrivateLinkServiceResourceIdOk + +`func (o *AzurePrivateLinkConnection) GetPrivateLinkServiceResourceIdOk() (*string, bool)` + +GetPrivateLinkServiceResourceIdOk returns a tuple with the PrivateLinkServiceResourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateLinkServiceResourceId + +`func (o *AzurePrivateLinkConnection) SetPrivateLinkServiceResourceId(v string)` + +SetPrivateLinkServiceResourceId sets PrivateLinkServiceResourceId field to given value. + +### HasPrivateLinkServiceResourceId + +`func (o *AzurePrivateLinkConnection) HasPrivateLinkServiceResourceId() bool` + +HasPrivateLinkServiceResourceId returns a boolean if a field has been set. + +### GetRegionName + +`func (o *AzurePrivateLinkConnection) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *AzurePrivateLinkConnection) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *AzurePrivateLinkConnection) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *AzurePrivateLinkConnection) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AzurePrivateLinkConnection) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AzurePrivateLinkConnection) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AzurePrivateLinkConnection) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AzurePrivateLinkConnection) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzureProviderSettings.md b/docs/docs/AzureProviderSettings.md new file mode 100644 index 00000000..67d2218b --- /dev/null +++ b/docs/docs/AzureProviderSettings.md @@ -0,0 +1,155 @@ +# AzureProviderSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoScaling** | Pointer to [**AzureAutoScaling**](AzureAutoScaling.md) | | [optional] +**DiskTypeName** | Pointer to **string** | Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies. | [optional] +**InstanceSizeName** | Pointer to **string** | Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. | [optional] +**RegionName** | Pointer to **string** | Microsoft Azure Regions. | [optional] +**ProviderName** | **string** | | + +## Methods + +### NewAzureProviderSettings + +`func NewAzureProviderSettings(providerName string, ) *AzureProviderSettings` + +NewAzureProviderSettings instantiates a new AzureProviderSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzureProviderSettingsWithDefaults + +`func NewAzureProviderSettingsWithDefaults() *AzureProviderSettings` + +NewAzureProviderSettingsWithDefaults instantiates a new AzureProviderSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoScaling + +`func (o *AzureProviderSettings) GetAutoScaling() AzureAutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *AzureProviderSettings) GetAutoScalingOk() (*AzureAutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *AzureProviderSettings) SetAutoScaling(v AzureAutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *AzureProviderSettings) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetDiskTypeName + +`func (o *AzureProviderSettings) GetDiskTypeName() string` + +GetDiskTypeName returns the DiskTypeName field if non-nil, zero value otherwise. + +### GetDiskTypeNameOk + +`func (o *AzureProviderSettings) GetDiskTypeNameOk() (*string, bool)` + +GetDiskTypeNameOk returns a tuple with the DiskTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskTypeName + +`func (o *AzureProviderSettings) SetDiskTypeName(v string)` + +SetDiskTypeName sets DiskTypeName field to given value. + +### HasDiskTypeName + +`func (o *AzureProviderSettings) HasDiskTypeName() bool` + +HasDiskTypeName returns a boolean if a field has been set. + +### GetInstanceSizeName + +`func (o *AzureProviderSettings) GetInstanceSizeName() string` + +GetInstanceSizeName returns the InstanceSizeName field if non-nil, zero value otherwise. + +### GetInstanceSizeNameOk + +`func (o *AzureProviderSettings) GetInstanceSizeNameOk() (*string, bool)` + +GetInstanceSizeNameOk returns a tuple with the InstanceSizeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSizeName + +`func (o *AzureProviderSettings) SetInstanceSizeName(v string)` + +SetInstanceSizeName sets InstanceSizeName field to given value. + +### HasInstanceSizeName + +`func (o *AzureProviderSettings) HasInstanceSizeName() bool` + +HasInstanceSizeName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *AzureProviderSettings) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *AzureProviderSettings) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *AzureProviderSettings) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *AzureProviderSettings) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AzureProviderSettings) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AzureProviderSettings) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AzureProviderSettings) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/AzureRegionConfig.md b/docs/docs/AzureRegionConfig.md new file mode 100644 index 00000000..6e0cf102 --- /dev/null +++ b/docs/docs/AzureRegionConfig.md @@ -0,0 +1,238 @@ +# AzureRegionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AnalyticsAutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**AnalyticsSpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**AutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**ReadOnlySpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**ElectableSpecs** | Pointer to [**HardwareSpec**](HardwareSpec.md) | | [optional] +**Priority** | Pointer to **int** | Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`. **Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively. | [optional] +**ProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`. | [optional] +**RegionName** | Pointer to **string** | Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. | [optional] + +## Methods + +### NewAzureRegionConfig + +`func NewAzureRegionConfig() *AzureRegionConfig` + +NewAzureRegionConfig instantiates a new AzureRegionConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAzureRegionConfigWithDefaults + +`func NewAzureRegionConfigWithDefaults() *AzureRegionConfig` + +NewAzureRegionConfigWithDefaults instantiates a new AzureRegionConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAnalyticsAutoScaling + +`func (o *AzureRegionConfig) GetAnalyticsAutoScaling() AutoScalingV15` + +GetAnalyticsAutoScaling returns the AnalyticsAutoScaling field if non-nil, zero value otherwise. + +### GetAnalyticsAutoScalingOk + +`func (o *AzureRegionConfig) GetAnalyticsAutoScalingOk() (*AutoScalingV15, bool)` + +GetAnalyticsAutoScalingOk returns a tuple with the AnalyticsAutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsAutoScaling + +`func (o *AzureRegionConfig) SetAnalyticsAutoScaling(v AutoScalingV15)` + +SetAnalyticsAutoScaling sets AnalyticsAutoScaling field to given value. + +### HasAnalyticsAutoScaling + +`func (o *AzureRegionConfig) HasAnalyticsAutoScaling() bool` + +HasAnalyticsAutoScaling returns a boolean if a field has been set. + +### GetAnalyticsSpecs + +`func (o *AzureRegionConfig) GetAnalyticsSpecs() DedicatedHardwareSpec` + +GetAnalyticsSpecs returns the AnalyticsSpecs field if non-nil, zero value otherwise. + +### GetAnalyticsSpecsOk + +`func (o *AzureRegionConfig) GetAnalyticsSpecsOk() (*DedicatedHardwareSpec, bool)` + +GetAnalyticsSpecsOk returns a tuple with the AnalyticsSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsSpecs + +`func (o *AzureRegionConfig) SetAnalyticsSpecs(v DedicatedHardwareSpec)` + +SetAnalyticsSpecs sets AnalyticsSpecs field to given value. + +### HasAnalyticsSpecs + +`func (o *AzureRegionConfig) HasAnalyticsSpecs() bool` + +HasAnalyticsSpecs returns a boolean if a field has been set. + +### GetAutoScaling + +`func (o *AzureRegionConfig) GetAutoScaling() AutoScalingV15` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *AzureRegionConfig) GetAutoScalingOk() (*AutoScalingV15, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *AzureRegionConfig) SetAutoScaling(v AutoScalingV15)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *AzureRegionConfig) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetReadOnlySpecs + +`func (o *AzureRegionConfig) GetReadOnlySpecs() DedicatedHardwareSpec` + +GetReadOnlySpecs returns the ReadOnlySpecs field if non-nil, zero value otherwise. + +### GetReadOnlySpecsOk + +`func (o *AzureRegionConfig) GetReadOnlySpecsOk() (*DedicatedHardwareSpec, bool)` + +GetReadOnlySpecsOk returns a tuple with the ReadOnlySpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadOnlySpecs + +`func (o *AzureRegionConfig) SetReadOnlySpecs(v DedicatedHardwareSpec)` + +SetReadOnlySpecs sets ReadOnlySpecs field to given value. + +### HasReadOnlySpecs + +`func (o *AzureRegionConfig) HasReadOnlySpecs() bool` + +HasReadOnlySpecs returns a boolean if a field has been set. + +### GetElectableSpecs + +`func (o *AzureRegionConfig) GetElectableSpecs() HardwareSpec` + +GetElectableSpecs returns the ElectableSpecs field if non-nil, zero value otherwise. + +### GetElectableSpecsOk + +`func (o *AzureRegionConfig) GetElectableSpecsOk() (*HardwareSpec, bool)` + +GetElectableSpecsOk returns a tuple with the ElectableSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElectableSpecs + +`func (o *AzureRegionConfig) SetElectableSpecs(v HardwareSpec)` + +SetElectableSpecs sets ElectableSpecs field to given value. + +### HasElectableSpecs + +`func (o *AzureRegionConfig) HasElectableSpecs() bool` + +HasElectableSpecs returns a boolean if a field has been set. + +### GetPriority + +`func (o *AzureRegionConfig) GetPriority() int` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *AzureRegionConfig) GetPriorityOk() (*int, bool)` + +GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPriority + +`func (o *AzureRegionConfig) SetPriority(v int)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *AzureRegionConfig) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetProviderName + +`func (o *AzureRegionConfig) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *AzureRegionConfig) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *AzureRegionConfig) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *AzureRegionConfig) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *AzureRegionConfig) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *AzureRegionConfig) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *AzureRegionConfig) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *AzureRegionConfig) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BSONTimestamp.md b/docs/docs/BSONTimestamp.md new file mode 100644 index 00000000..4b5428d3 --- /dev/null +++ b/docs/docs/BSONTimestamp.md @@ -0,0 +1,82 @@ +# BSONTimestamp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **time.Time** | Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Increment** | Pointer to **int** | Order of the database operation that the oplog recorded at specific date and time. | [optional] [readonly] + +## Methods + +### NewBSONTimestamp + +`func NewBSONTimestamp() *BSONTimestamp` + +NewBSONTimestamp instantiates a new BSONTimestamp object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBSONTimestampWithDefaults + +`func NewBSONTimestampWithDefaults() *BSONTimestamp` + +NewBSONTimestampWithDefaults instantiates a new BSONTimestamp object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDate + +`func (o *BSONTimestamp) GetDate() time.Time` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *BSONTimestamp) GetDateOk() (*time.Time, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *BSONTimestamp) SetDate(v time.Time)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *BSONTimestamp) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetIncrement + +`func (o *BSONTimestamp) GetIncrement() int` + +GetIncrement returns the Increment field if non-nil, zero value otherwise. + +### GetIncrementOk + +`func (o *BSONTimestamp) GetIncrementOk() (*int, bool)` + +GetIncrementOk returns a tuple with the Increment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncrement + +`func (o *BSONTimestamp) SetIncrement(v int)` + +SetIncrement sets Increment field to given value. + +### HasIncrement + +`func (o *BSONTimestamp) HasIncrement() bool` + +HasIncrement returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BiConnector.md b/docs/docs/BiConnector.md new file mode 100644 index 00000000..3a217540 --- /dev/null +++ b/docs/docs/BiConnector.md @@ -0,0 +1,82 @@ +# BiConnector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster. | [optional] +**ReadPreference** | Pointer to **string** | Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes. | [optional] + +## Methods + +### NewBiConnector + +`func NewBiConnector() *BiConnector` + +NewBiConnector instantiates a new BiConnector object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBiConnectorWithDefaults + +`func NewBiConnectorWithDefaults() *BiConnector` + +NewBiConnectorWithDefaults instantiates a new BiConnector object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *BiConnector) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *BiConnector) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *BiConnector) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *BiConnector) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetReadPreference + +`func (o *BiConnector) GetReadPreference() string` + +GetReadPreference returns the ReadPreference field if non-nil, zero value otherwise. + +### GetReadPreferenceOk + +`func (o *BiConnector) GetReadPreferenceOk() (*string, bool)` + +GetReadPreferenceOk returns a tuple with the ReadPreference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadPreference + +`func (o *BiConnector) SetReadPreference(v string)` + +SetReadPreference sets ReadPreference field to given value. + +### HasReadPreference + +`func (o *BiConnector) HasReadPreference() bool` + +HasReadPreference returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BillingEventTypeViewAlertableWithThreshold.md b/docs/docs/BillingEventTypeViewAlertableWithThreshold.md new file mode 100644 index 00000000..f2badc07 --- /dev/null +++ b/docs/docs/BillingEventTypeViewAlertableWithThreshold.md @@ -0,0 +1,13 @@ +# BillingEventTypeViewAlertableWithThreshold + +## Enum + + +* `PENDING_INVOICE_OVER_THRESHOLD` (value: `"PENDING_INVOICE_OVER_THRESHOLD"`) + +* `DAILY_BILL_OVER_THRESHOLD` (value: `"DAILY_BILL_OVER_THRESHOLD"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BillingEventTypeViewForNdsGroup.md b/docs/docs/BillingEventTypeViewForNdsGroup.md new file mode 100644 index 00000000..6ab9a42b --- /dev/null +++ b/docs/docs/BillingEventTypeViewForNdsGroup.md @@ -0,0 +1,103 @@ +# BillingEventTypeViewForNdsGroup + +## Enum + + +* `CREDIT_CARD_CURRENT` (value: `"CREDIT_CARD_CURRENT"`) + +* `CREDIT_CARD_ABOUT_TO_EXPIRE` (value: `"CREDIT_CARD_ABOUT_TO_EXPIRE"`) + +* `PENDING_INVOICE_UNDER_THRESHOLD` (value: `"PENDING_INVOICE_UNDER_THRESHOLD"`) + +* `PENDING_INVOICE_OVER_THRESHOLD` (value: `"PENDING_INVOICE_OVER_THRESHOLD"`) + +* `DAILY_BILL_UNDER_THRESHOLD` (value: `"DAILY_BILL_UNDER_THRESHOLD"`) + +* `DAILY_BILL_OVER_THRESHOLD` (value: `"DAILY_BILL_OVER_THRESHOLD"`) + +* `CHARGE_SUCCEEDED` (value: `"CHARGE_SUCCEEDED"`) + +* `CHARGE_FAILED` (value: `"CHARGE_FAILED"`) + +* `CHARGE_PROCESSING` (value: `"CHARGE_PROCESSING"`) + +* `CHARGE_PENDING_REVERSAL` (value: `"CHARGE_PENDING_REVERSAL"`) + +* `BRAINTREE_CHARGE_FAILED` (value: `"BRAINTREE_CHARGE_FAILED"`) + +* `INVOICE_CLOSED` (value: `"INVOICE_CLOSED"`) + +* `CHECK_PAYMENT_RECEIVED` (value: `"CHECK_PAYMENT_RECEIVED"`) + +* `WIRE_TRANSFER_PAYMENT_RECEIVED` (value: `"WIRE_TRANSFER_PAYMENT_RECEIVED"`) + +* `DISCOUNT_APPLIED` (value: `"DISCOUNT_APPLIED"`) + +* `CREDIT_ISSUED` (value: `"CREDIT_ISSUED"`) + +* `CREDIT_PULLED_FWD` (value: `"CREDIT_PULLED_FWD"`) + +* `CREDIT_START_DATE_MODIFIED` (value: `"CREDIT_START_DATE_MODIFIED"`) + +* `CREDIT_END_DATE_MODIFIED` (value: `"CREDIT_END_DATE_MODIFIED"`) + +* `CREDIT_ELASTIC_INVOICING_MODIFIED` (value: `"CREDIT_ELASTIC_INVOICING_MODIFIED"`) + +* `CREDIT_TYPE_MODIFIED` (value: `"CREDIT_TYPE_MODIFIED"`) + +* `CREDIT_AMOUNT_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_CENTS_MODIFIED"`) + +* `CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED"`) + +* `CREDIT_TOTAL_BILLED_CENTS_MODIFIED` (value: `"CREDIT_TOTAL_BILLED_CENTS_MODIFIED"`) + +* `CREDIT_AWS_CUSTOMER_ID_MODIFIED` (value: `"CREDIT_AWS_CUSTOMER_ID_MODIFIED"`) + +* `CREDIT_AWS_PRODUCT_CODE_MODIFIED` (value: `"CREDIT_AWS_PRODUCT_CODE_MODIFIED"`) + +* `CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED` (value: `"CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED"`) + +* `CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED` (value: `"CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED"`) + +* `PROMO_CODE_APPLIED` (value: `"PROMO_CODE_APPLIED"`) + +* `PAYMENT_FORGIVEN` (value: `"PAYMENT_FORGIVEN"`) + +* `REFUND_ISSUED` (value: `"REFUND_ISSUED"`) + +* `ACCOUNT_DOWNGRADED` (value: `"ACCOUNT_DOWNGRADED"`) + +* `ACCOUNT_UPGRADED` (value: `"ACCOUNT_UPGRADED"`) + +* `ACCOUNT_MODIFIED` (value: `"ACCOUNT_MODIFIED"`) + +* `SUPPORT_PLAN_ACTIVATED` (value: `"SUPPORT_PLAN_ACTIVATED"`) + +* `SUPPORT_PLAN_CANCELLED` (value: `"SUPPORT_PLAN_CANCELLED"`) + +* `SUPPORT_PLAN_CANCELLATION_SCHEDULED` (value: `"SUPPORT_PLAN_CANCELLATION_SCHEDULED"`) + +* `INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC` (value: `"INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC"`) + +* `INVOICE_ADDRESS_CHANGED` (value: `"INVOICE_ADDRESS_CHANGED"`) + +* `INVOICE_ADDRESS_ADDED` (value: `"INVOICE_ADDRESS_ADDED"`) + +* `PREPAID_PLAN_ACTIVATED` (value: `"PREPAID_PLAN_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_ACTIVATED` (value: `"ELASTIC_INVOICING_MODE_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_DEACTIVATED` (value: `"ELASTIC_INVOICING_MODE_DEACTIVATED"`) + +* `TERMINATE_PAID_SERVICES` (value: `"TERMINATE_PAID_SERVICES"`) + +* `BILLING_EMAIL_ADDRESS_ADDED` (value: `"BILLING_EMAIL_ADDRESS_ADDED"`) + +* `BILLING_EMAIL_ADDRESS_CHANGED` (value: `"BILLING_EMAIL_ADDRESS_CHANGED"`) + +* `BILLING_EMAIL_ADDRESS_REMOVED` (value: `"BILLING_EMAIL_ADDRESS_REMOVED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BillingEventTypeViewForOrg.md b/docs/docs/BillingEventTypeViewForOrg.md new file mode 100644 index 00000000..d3149471 --- /dev/null +++ b/docs/docs/BillingEventTypeViewForOrg.md @@ -0,0 +1,123 @@ +# BillingEventTypeViewForOrg + +## Enum + + +* `CHARGE_SUCCEEDED` (value: `"CHARGE_SUCCEEDED"`) + +* `CHARGE_FAILED` (value: `"CHARGE_FAILED"`) + +* `CHARGE_PROCESSING` (value: `"CHARGE_PROCESSING"`) + +* `CHARGE_PENDING_REVERSAL` (value: `"CHARGE_PENDING_REVERSAL"`) + +* `BRAINTREE_CHARGE_FAILED` (value: `"BRAINTREE_CHARGE_FAILED"`) + +* `INVOICE_CLOSED` (value: `"INVOICE_CLOSED"`) + +* `CHECK_PAYMENT_RECEIVED` (value: `"CHECK_PAYMENT_RECEIVED"`) + +* `WIRE_TRANSFER_PAYMENT_RECEIVED` (value: `"WIRE_TRANSFER_PAYMENT_RECEIVED"`) + +* `DISCOUNT_APPLIED` (value: `"DISCOUNT_APPLIED"`) + +* `CREDIT_ISSUED` (value: `"CREDIT_ISSUED"`) + +* `CREDIT_PULLED_FWD` (value: `"CREDIT_PULLED_FWD"`) + +* `CREDIT_END_DATE_MODIFIED` (value: `"CREDIT_END_DATE_MODIFIED"`) + +* `PROMO_CODE_APPLIED` (value: `"PROMO_CODE_APPLIED"`) + +* `PAYMENT_FORGIVEN` (value: `"PAYMENT_FORGIVEN"`) + +* `REFUND_ISSUED` (value: `"REFUND_ISSUED"`) + +* `ACCOUNT_DOWNGRADED` (value: `"ACCOUNT_DOWNGRADED"`) + +* `ACCOUNT_UPGRADED` (value: `"ACCOUNT_UPGRADED"`) + +* `ACCOUNT_MODIFIED` (value: `"ACCOUNT_MODIFIED"`) + +* `SUPPORT_PLAN_ACTIVATED` (value: `"SUPPORT_PLAN_ACTIVATED"`) + +* `SUPPORT_PLAN_CANCELLED` (value: `"SUPPORT_PLAN_CANCELLED"`) + +* `SUPPORT_PLAN_CANCELLATION_SCHEDULED` (value: `"SUPPORT_PLAN_CANCELLATION_SCHEDULED"`) + +* `INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC` (value: `"INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC"`) + +* `INVOICE_ADDRESS_CHANGED` (value: `"INVOICE_ADDRESS_CHANGED"`) + +* `INVOICE_ADDRESS_ADDED` (value: `"INVOICE_ADDRESS_ADDED"`) + +* `PREPAID_PLAN_ACTIVATED` (value: `"PREPAID_PLAN_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_ACTIVATED` (value: `"ELASTIC_INVOICING_MODE_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_DEACTIVATED` (value: `"ELASTIC_INVOICING_MODE_DEACTIVATED"`) + +* `TERMINATE_PAID_SERVICES` (value: `"TERMINATE_PAID_SERVICES"`) + +* `BILLING_EMAIL_ADDRESS_ADDED` (value: `"BILLING_EMAIL_ADDRESS_ADDED"`) + +* `BILLING_EMAIL_ADDRESS_CHANGED` (value: `"BILLING_EMAIL_ADDRESS_CHANGED"`) + +* `BILLING_EMAIL_ADDRESS_REMOVED` (value: `"BILLING_EMAIL_ADDRESS_REMOVED"`) + +* `AWS_BILLING_ACCOUNT_CREDIT_ISSUED` (value: `"AWS_BILLING_ACCOUNT_CREDIT_ISSUED"`) + +* `GCP_BILLING_ACCOUNT_CREDIT_ISSUED` (value: `"GCP_BILLING_ACCOUNT_CREDIT_ISSUED"`) + +* `CREDIT_SFOLI_MODIFIED` (value: `"CREDIT_SFOLI_MODIFIED"`) + +* `CREDIT_SFOLID_MODIFIED` (value: `"CREDIT_SFOLID_MODIFIED"`) + +* `CREDIT_AMOUNT_MODIFIED` (value: `"CREDIT_AMOUNT_MODIFIED"`) + +* `PREPAID_PLAN_MODIFIED` (value: `"PREPAID_PLAN_MODIFIED"`) + +* `AWS_USAGE_REPORTED` (value: `"AWS_USAGE_REPORTED"`) + +* `AZURE_USAGE_REPORTED` (value: `"AZURE_USAGE_REPORTED"`) + +* `GCP_USAGE_REPORTED` (value: `"GCP_USAGE_REPORTED"`) + +* `BECAME_PAYING_ORG` (value: `"BECAME_PAYING_ORG"`) + +* `NEW_LINKED_ORG` (value: `"NEW_LINKED_ORG"`) + +* `UNLINKED_ORG` (value: `"UNLINKED_ORG"`) + +* `ORG_LINKED_TO_PAYING_ORG` (value: `"ORG_LINKED_TO_PAYING_ORG"`) + +* `ORG_UNLINKED_FROM_PAYING_ORG` (value: `"ORG_UNLINKED_FROM_PAYING_ORG"`) + +* `PAYMENT_UPDATED_THROUGH_API` (value: `"PAYMENT_UPDATED_THROUGH_API"`) + +* `AZURE_BILLING_ACCOUNT_CREDIT_ISSUED` (value: `"AZURE_BILLING_ACCOUNT_CREDIT_ISSUED"`) + +* `CREDIT_START_DATE_MODIFIED` (value: `"CREDIT_START_DATE_MODIFIED"`) + +* `CREDIT_ELASTIC_INVOICING_MODIFIED` (value: `"CREDIT_ELASTIC_INVOICING_MODIFIED"`) + +* `CREDIT_TYPE_MODIFIED` (value: `"CREDIT_TYPE_MODIFIED"`) + +* `CREDIT_AMOUNT_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_CENTS_MODIFIED"`) + +* `CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED"`) + +* `CREDIT_TOTAL_BILLED_CENTS_MODIFIED` (value: `"CREDIT_TOTAL_BILLED_CENTS_MODIFIED"`) + +* `CREDIT_AWS_CUSTOMER_ID_MODIFIED` (value: `"CREDIT_AWS_CUSTOMER_ID_MODIFIED"`) + +* `CREDIT_AWS_PRODUCT_CODE_MODIFIED` (value: `"CREDIT_AWS_PRODUCT_CODE_MODIFIED"`) + +* `CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED` (value: `"CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED"`) + +* `CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED` (value: `"CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BillingEventViewForNdsGroup.md b/docs/docs/BillingEventViewForNdsGroup.md new file mode 100644 index 00000000..e8220721 --- /dev/null +++ b/docs/docs/BillingEventViewForNdsGroup.md @@ -0,0 +1,405 @@ +# BillingEventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**BillingEventTypeViewForNdsGroup**](BillingEventTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**InvoiceId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. | [optional] [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PaymentId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewBillingEventViewForNdsGroup + +`func NewBillingEventViewForNdsGroup(created time.Time, eventTypeName BillingEventTypeViewForNdsGroup, id string, ) *BillingEventViewForNdsGroup` + +NewBillingEventViewForNdsGroup instantiates a new BillingEventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBillingEventViewForNdsGroupWithDefaults + +`func NewBillingEventViewForNdsGroupWithDefaults() *BillingEventViewForNdsGroup` + +NewBillingEventViewForNdsGroupWithDefaults instantiates a new BillingEventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *BillingEventViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *BillingEventViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *BillingEventViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *BillingEventViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *BillingEventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BillingEventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BillingEventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *BillingEventViewForNdsGroup) GetEventTypeName() BillingEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *BillingEventViewForNdsGroup) GetEventTypeNameOk() (*BillingEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *BillingEventViewForNdsGroup) SetEventTypeName(v BillingEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *BillingEventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *BillingEventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *BillingEventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *BillingEventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *BillingEventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BillingEventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BillingEventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetInvoiceId + +`func (o *BillingEventViewForNdsGroup) GetInvoiceId() string` + +GetInvoiceId returns the InvoiceId field if non-nil, zero value otherwise. + +### GetInvoiceIdOk + +`func (o *BillingEventViewForNdsGroup) GetInvoiceIdOk() (*string, bool)` + +GetInvoiceIdOk returns a tuple with the InvoiceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInvoiceId + +`func (o *BillingEventViewForNdsGroup) SetInvoiceId(v string)` + +SetInvoiceId sets InvoiceId field to given value. + +### HasInvoiceId + +`func (o *BillingEventViewForNdsGroup) HasInvoiceId() bool` + +HasInvoiceId returns a boolean if a field has been set. + +### GetIsGlobalAdmin + +`func (o *BillingEventViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *BillingEventViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *BillingEventViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *BillingEventViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *BillingEventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *BillingEventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *BillingEventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *BillingEventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *BillingEventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *BillingEventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *BillingEventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *BillingEventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPaymentId + +`func (o *BillingEventViewForNdsGroup) GetPaymentId() string` + +GetPaymentId returns the PaymentId field if non-nil, zero value otherwise. + +### GetPaymentIdOk + +`func (o *BillingEventViewForNdsGroup) GetPaymentIdOk() (*string, bool)` + +GetPaymentIdOk returns a tuple with the PaymentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPaymentId + +`func (o *BillingEventViewForNdsGroup) SetPaymentId(v string)` + +SetPaymentId sets PaymentId field to given value. + +### HasPaymentId + +`func (o *BillingEventViewForNdsGroup) HasPaymentId() bool` + +HasPaymentId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *BillingEventViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *BillingEventViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *BillingEventViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *BillingEventViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *BillingEventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *BillingEventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *BillingEventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *BillingEventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *BillingEventViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *BillingEventViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *BillingEventViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *BillingEventViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *BillingEventViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *BillingEventViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *BillingEventViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *BillingEventViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *BillingEventViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *BillingEventViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *BillingEventViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *BillingEventViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BillingEventViewForOrg.md b/docs/docs/BillingEventViewForOrg.md new file mode 100644 index 00000000..92536445 --- /dev/null +++ b/docs/docs/BillingEventViewForOrg.md @@ -0,0 +1,405 @@ +# BillingEventViewForOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**BillingEventTypeViewForOrg**](BillingEventTypeViewForOrg.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**InvoiceId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. | [optional] [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PaymentId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewBillingEventViewForOrg + +`func NewBillingEventViewForOrg(created time.Time, eventTypeName BillingEventTypeViewForOrg, id string, ) *BillingEventViewForOrg` + +NewBillingEventViewForOrg instantiates a new BillingEventViewForOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBillingEventViewForOrgWithDefaults + +`func NewBillingEventViewForOrgWithDefaults() *BillingEventViewForOrg` + +NewBillingEventViewForOrgWithDefaults instantiates a new BillingEventViewForOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *BillingEventViewForOrg) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *BillingEventViewForOrg) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *BillingEventViewForOrg) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *BillingEventViewForOrg) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *BillingEventViewForOrg) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BillingEventViewForOrg) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BillingEventViewForOrg) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *BillingEventViewForOrg) GetEventTypeName() BillingEventTypeViewForOrg` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *BillingEventViewForOrg) GetEventTypeNameOk() (*BillingEventTypeViewForOrg, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *BillingEventViewForOrg) SetEventTypeName(v BillingEventTypeViewForOrg)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *BillingEventViewForOrg) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *BillingEventViewForOrg) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *BillingEventViewForOrg) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *BillingEventViewForOrg) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *BillingEventViewForOrg) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BillingEventViewForOrg) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BillingEventViewForOrg) SetId(v string)` + +SetId sets Id field to given value. + + +### GetInvoiceId + +`func (o *BillingEventViewForOrg) GetInvoiceId() string` + +GetInvoiceId returns the InvoiceId field if non-nil, zero value otherwise. + +### GetInvoiceIdOk + +`func (o *BillingEventViewForOrg) GetInvoiceIdOk() (*string, bool)` + +GetInvoiceIdOk returns a tuple with the InvoiceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInvoiceId + +`func (o *BillingEventViewForOrg) SetInvoiceId(v string)` + +SetInvoiceId sets InvoiceId field to given value. + +### HasInvoiceId + +`func (o *BillingEventViewForOrg) HasInvoiceId() bool` + +HasInvoiceId returns a boolean if a field has been set. + +### GetIsGlobalAdmin + +`func (o *BillingEventViewForOrg) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *BillingEventViewForOrg) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *BillingEventViewForOrg) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *BillingEventViewForOrg) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *BillingEventViewForOrg) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *BillingEventViewForOrg) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *BillingEventViewForOrg) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *BillingEventViewForOrg) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *BillingEventViewForOrg) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *BillingEventViewForOrg) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *BillingEventViewForOrg) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *BillingEventViewForOrg) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPaymentId + +`func (o *BillingEventViewForOrg) GetPaymentId() string` + +GetPaymentId returns the PaymentId field if non-nil, zero value otherwise. + +### GetPaymentIdOk + +`func (o *BillingEventViewForOrg) GetPaymentIdOk() (*string, bool)` + +GetPaymentIdOk returns a tuple with the PaymentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPaymentId + +`func (o *BillingEventViewForOrg) SetPaymentId(v string)` + +SetPaymentId sets PaymentId field to given value. + +### HasPaymentId + +`func (o *BillingEventViewForOrg) HasPaymentId() bool` + +HasPaymentId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *BillingEventViewForOrg) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *BillingEventViewForOrg) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *BillingEventViewForOrg) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *BillingEventViewForOrg) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *BillingEventViewForOrg) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *BillingEventViewForOrg) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *BillingEventViewForOrg) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *BillingEventViewForOrg) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *BillingEventViewForOrg) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *BillingEventViewForOrg) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *BillingEventViewForOrg) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *BillingEventViewForOrg) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *BillingEventViewForOrg) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *BillingEventViewForOrg) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *BillingEventViewForOrg) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *BillingEventViewForOrg) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *BillingEventViewForOrg) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *BillingEventViewForOrg) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *BillingEventViewForOrg) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *BillingEventViewForOrg) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/BillingThresholdAlertConfigViewForNdsGroup.md b/docs/docs/BillingThresholdAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..a0340214 --- /dev/null +++ b/docs/docs/BillingThresholdAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# BillingThresholdAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**BillingEventTypeViewAlertableWithThreshold**](BillingEventTypeViewAlertableWithThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**GreaterThanRawThreshold**](GreaterThanRawThreshold.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewBillingThresholdAlertConfigViewForNdsGroup + +`func NewBillingThresholdAlertConfigViewForNdsGroup(eventTypeName BillingEventTypeViewAlertableWithThreshold, ) *BillingThresholdAlertConfigViewForNdsGroup` + +NewBillingThresholdAlertConfigViewForNdsGroup instantiates a new BillingThresholdAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBillingThresholdAlertConfigViewForNdsGroupWithDefaults + +`func NewBillingThresholdAlertConfigViewForNdsGroupWithDefaults() *BillingThresholdAlertConfigViewForNdsGroup` + +NewBillingThresholdAlertConfigViewForNdsGroupWithDefaults instantiates a new BillingThresholdAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetEventTypeName() BillingEventTypeViewAlertableWithThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*BillingEventTypeViewAlertableWithThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetEventTypeName(v BillingEventTypeViewAlertableWithThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetThreshold() GreaterThanRawThreshold` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetThresholdOk() (*GreaterThanRawThreshold, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetThreshold(v GreaterThanRawThreshold)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *BillingThresholdAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CharFilterhtmlStrip.md b/docs/docs/CharFilterhtmlStrip.md new file mode 100644 index 00000000..41543cf3 --- /dev/null +++ b/docs/docs/CharFilterhtmlStrip.md @@ -0,0 +1,77 @@ +# CharFilterhtmlStrip + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IgnoredTags** | Pointer to **[]string** | The HTML tags that you want to exclude from filtering. | [optional] +**Type** | **string** | Human-readable label that identifies this character filter type. | + +## Methods + +### NewCharFilterhtmlStrip + +`func NewCharFilterhtmlStrip(type_ string, ) *CharFilterhtmlStrip` + +NewCharFilterhtmlStrip instantiates a new CharFilterhtmlStrip object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCharFilterhtmlStripWithDefaults + +`func NewCharFilterhtmlStripWithDefaults() *CharFilterhtmlStrip` + +NewCharFilterhtmlStripWithDefaults instantiates a new CharFilterhtmlStrip object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIgnoredTags + +`func (o *CharFilterhtmlStrip) GetIgnoredTags() []string` + +GetIgnoredTags returns the IgnoredTags field if non-nil, zero value otherwise. + +### GetIgnoredTagsOk + +`func (o *CharFilterhtmlStrip) GetIgnoredTagsOk() (*[]string, bool)` + +GetIgnoredTagsOk returns a tuple with the IgnoredTags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoredTags + +`func (o *CharFilterhtmlStrip) SetIgnoredTags(v []string)` + +SetIgnoredTags sets IgnoredTags field to given value. + +### HasIgnoredTags + +`func (o *CharFilterhtmlStrip) HasIgnoredTags() bool` + +HasIgnoredTags returns a boolean if a field has been set. + +### GetType + +`func (o *CharFilterhtmlStrip) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CharFilterhtmlStrip) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CharFilterhtmlStrip) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CharFiltericuNormalize.md b/docs/docs/CharFiltericuNormalize.md new file mode 100644 index 00000000..fcf18ad6 --- /dev/null +++ b/docs/docs/CharFiltericuNormalize.md @@ -0,0 +1,51 @@ +# CharFiltericuNormalize + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Human-readable label that identifies this character filter type. | + +## Methods + +### NewCharFiltericuNormalize + +`func NewCharFiltericuNormalize(type_ string, ) *CharFiltericuNormalize` + +NewCharFiltericuNormalize instantiates a new CharFiltericuNormalize object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCharFiltericuNormalizeWithDefaults + +`func NewCharFiltericuNormalizeWithDefaults() *CharFiltericuNormalize` + +NewCharFiltericuNormalizeWithDefaults instantiates a new CharFiltericuNormalize object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *CharFiltericuNormalize) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CharFiltericuNormalize) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CharFiltericuNormalize) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CharFiltermapping.md b/docs/docs/CharFiltermapping.md new file mode 100644 index 00000000..21641c0a --- /dev/null +++ b/docs/docs/CharFiltermapping.md @@ -0,0 +1,72 @@ +# CharFiltermapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Mappings** | [**CharFiltermappingMappings**](CharFiltermappingMappings.md) | | +**Type** | **string** | Human-readable label that identifies this character filter type. | + +## Methods + +### NewCharFiltermapping + +`func NewCharFiltermapping(mappings CharFiltermappingMappings, type_ string, ) *CharFiltermapping` + +NewCharFiltermapping instantiates a new CharFiltermapping object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCharFiltermappingWithDefaults + +`func NewCharFiltermappingWithDefaults() *CharFiltermapping` + +NewCharFiltermappingWithDefaults instantiates a new CharFiltermapping object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMappings + +`func (o *CharFiltermapping) GetMappings() CharFiltermappingMappings` + +GetMappings returns the Mappings field if non-nil, zero value otherwise. + +### GetMappingsOk + +`func (o *CharFiltermapping) GetMappingsOk() (*CharFiltermappingMappings, bool)` + +GetMappingsOk returns a tuple with the Mappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappings + +`func (o *CharFiltermapping) SetMappings(v CharFiltermappingMappings)` + +SetMappings sets Mappings field to given value. + + +### GetType + +`func (o *CharFiltermapping) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CharFiltermapping) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CharFiltermapping) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CharFiltermappingMappings.md b/docs/docs/CharFiltermappingMappings.md new file mode 100644 index 00000000..33306ab0 --- /dev/null +++ b/docs/docs/CharFiltermappingMappings.md @@ -0,0 +1,56 @@ +# CharFiltermappingMappings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdditionalPropertiesField** | Pointer to **string** | | [optional] + +## Methods + +### NewCharFiltermappingMappings + +`func NewCharFiltermappingMappings() *CharFiltermappingMappings` + +NewCharFiltermappingMappings instantiates a new CharFiltermappingMappings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCharFiltermappingMappingsWithDefaults + +`func NewCharFiltermappingMappingsWithDefaults() *CharFiltermappingMappings` + +NewCharFiltermappingMappingsWithDefaults instantiates a new CharFiltermappingMappings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAdditionalPropertiesField + +`func (o *CharFiltermappingMappings) GetAdditionalPropertiesField() string` + +GetAdditionalPropertiesField returns the AdditionalPropertiesField field if non-nil, zero value otherwise. + +### GetAdditionalPropertiesFieldOk + +`func (o *CharFiltermappingMappings) GetAdditionalPropertiesFieldOk() (*string, bool)` + +GetAdditionalPropertiesFieldOk returns a tuple with the AdditionalPropertiesField field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdditionalPropertiesField + +`func (o *CharFiltermappingMappings) SetAdditionalPropertiesField(v string)` + +SetAdditionalPropertiesField sets AdditionalPropertiesField field to given value. + +### HasAdditionalPropertiesField + +`func (o *CharFiltermappingMappings) HasAdditionalPropertiesField() bool` + +HasAdditionalPropertiesField returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CharFilterpersian.md b/docs/docs/CharFilterpersian.md new file mode 100644 index 00000000..66beb87a --- /dev/null +++ b/docs/docs/CharFilterpersian.md @@ -0,0 +1,51 @@ +# CharFilterpersian + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Human-readable label that identifies this character filter type. | + +## Methods + +### NewCharFilterpersian + +`func NewCharFilterpersian(type_ string, ) *CharFilterpersian` + +NewCharFilterpersian instantiates a new CharFilterpersian object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCharFilterpersianWithDefaults + +`func NewCharFilterpersianWithDefaults() *CharFilterpersian` + +NewCharFilterpersianWithDefaults instantiates a new CharFilterpersian object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *CharFilterpersian) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CharFilterpersian) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CharFilterpersian) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Checkpoint.md b/docs/docs/Checkpoint.md new file mode 100644 index 00000000..113798d0 --- /dev/null +++ b/docs/docs/Checkpoint.md @@ -0,0 +1,264 @@ +# Checkpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint. | [optional] [readonly] +**Completed** | Pointer to **time.Time** | Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies checkpoint. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Parts** | Pointer to [**[]CheckpointPart**](CheckpointPart.md) | Metadata that describes the complete snapshot. - For a replica set, this array contains a single document. - For a sharded cluster, this array contains one document for each shard plus one document for the config host. | [optional] [readonly] +**Restorable** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore. | [optional] [readonly] +**Started** | Pointer to **time.Time** | Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Timestamp** | Pointer to **time.Time** | Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewCheckpoint + +`func NewCheckpoint() *Checkpoint` + +NewCheckpoint instantiates a new Checkpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCheckpointWithDefaults + +`func NewCheckpointWithDefaults() *Checkpoint` + +NewCheckpointWithDefaults instantiates a new Checkpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterId + +`func (o *Checkpoint) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *Checkpoint) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *Checkpoint) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + +### HasClusterId + +`func (o *Checkpoint) HasClusterId() bool` + +HasClusterId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *Checkpoint) GetCompleted() time.Time` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *Checkpoint) GetCompletedOk() (*time.Time, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *Checkpoint) SetCompleted(v time.Time)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *Checkpoint) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetGroupId + +`func (o *Checkpoint) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *Checkpoint) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *Checkpoint) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *Checkpoint) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *Checkpoint) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Checkpoint) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Checkpoint) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Checkpoint) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *Checkpoint) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Checkpoint) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Checkpoint) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Checkpoint) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetParts + +`func (o *Checkpoint) GetParts() []CheckpointPart` + +GetParts returns the Parts field if non-nil, zero value otherwise. + +### GetPartsOk + +`func (o *Checkpoint) GetPartsOk() (*[]CheckpointPart, bool)` + +GetPartsOk returns a tuple with the Parts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParts + +`func (o *Checkpoint) SetParts(v []CheckpointPart)` + +SetParts sets Parts field to given value. + +### HasParts + +`func (o *Checkpoint) HasParts() bool` + +HasParts returns a boolean if a field has been set. + +### GetRestorable + +`func (o *Checkpoint) GetRestorable() bool` + +GetRestorable returns the Restorable field if non-nil, zero value otherwise. + +### GetRestorableOk + +`func (o *Checkpoint) GetRestorableOk() (*bool, bool)` + +GetRestorableOk returns a tuple with the Restorable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestorable + +`func (o *Checkpoint) SetRestorable(v bool)` + +SetRestorable sets Restorable field to given value. + +### HasRestorable + +`func (o *Checkpoint) HasRestorable() bool` + +HasRestorable returns a boolean if a field has been set. + +### GetStarted + +`func (o *Checkpoint) GetStarted() time.Time` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *Checkpoint) GetStartedOk() (*time.Time, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *Checkpoint) SetStarted(v time.Time)` + +SetStarted sets Started field to given value. + +### HasStarted + +`func (o *Checkpoint) HasStarted() bool` + +HasStarted returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *Checkpoint) GetTimestamp() time.Time` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *Checkpoint) GetTimestampOk() (*time.Time, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *Checkpoint) SetTimestamp(v time.Time)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *Checkpoint) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CheckpointPart.md b/docs/docs/CheckpointPart.md new file mode 100644 index 00000000..8afbae29 --- /dev/null +++ b/docs/docs/CheckpointPart.md @@ -0,0 +1,160 @@ +# CheckpointPart + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReplicaSetName** | Pointer to **string** | Human-readable label that identifies the replica set to which this checkpoint applies. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label that identifies the shard to which this checkpoint applies. | [optional] [readonly] +**TokenDiscovered** | Pointer to **bool** | Flag that indicates whether the token exists. | [optional] [readonly] +**TokenTimestamp** | Pointer to [**BSONTimestamp**](BSONTimestamp.md) | | [optional] +**TypeName** | Pointer to **string** | Human-readable label that identifies the type of host that the part represents. | [optional] [readonly] + +## Methods + +### NewCheckpointPart + +`func NewCheckpointPart() *CheckpointPart` + +NewCheckpointPart instantiates a new CheckpointPart object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCheckpointPartWithDefaults + +`func NewCheckpointPartWithDefaults() *CheckpointPart` + +NewCheckpointPartWithDefaults instantiates a new CheckpointPart object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetReplicaSetName + +`func (o *CheckpointPart) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *CheckpointPart) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *CheckpointPart) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *CheckpointPart) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *CheckpointPart) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *CheckpointPart) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *CheckpointPart) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *CheckpointPart) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetTokenDiscovered + +`func (o *CheckpointPart) GetTokenDiscovered() bool` + +GetTokenDiscovered returns the TokenDiscovered field if non-nil, zero value otherwise. + +### GetTokenDiscoveredOk + +`func (o *CheckpointPart) GetTokenDiscoveredOk() (*bool, bool)` + +GetTokenDiscoveredOk returns a tuple with the TokenDiscovered field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenDiscovered + +`func (o *CheckpointPart) SetTokenDiscovered(v bool)` + +SetTokenDiscovered sets TokenDiscovered field to given value. + +### HasTokenDiscovered + +`func (o *CheckpointPart) HasTokenDiscovered() bool` + +HasTokenDiscovered returns a boolean if a field has been set. + +### GetTokenTimestamp + +`func (o *CheckpointPart) GetTokenTimestamp() BSONTimestamp` + +GetTokenTimestamp returns the TokenTimestamp field if non-nil, zero value otherwise. + +### GetTokenTimestampOk + +`func (o *CheckpointPart) GetTokenTimestampOk() (*BSONTimestamp, bool)` + +GetTokenTimestampOk returns a tuple with the TokenTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenTimestamp + +`func (o *CheckpointPart) SetTokenTimestamp(v BSONTimestamp)` + +SetTokenTimestamp sets TokenTimestamp field to given value. + +### HasTokenTimestamp + +`func (o *CheckpointPart) HasTokenTimestamp() bool` + +HasTokenTimestamp returns a boolean if a field has been set. + +### GetTypeName + +`func (o *CheckpointPart) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *CheckpointPart) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *CheckpointPart) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + +### HasTypeName + +`func (o *CheckpointPart) HasTypeName() bool` + +HasTypeName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudBackupsApi.md b/docs/docs/CloudBackupsApi.md new file mode 100644 index 00000000..b019e8aa --- /dev/null +++ b/docs/docs/CloudBackupsApi.md @@ -0,0 +1,2320 @@ +# \CloudBackupsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CancelBackupRestoreJob**](CloudBackupsApi.md#CancelBackupRestoreJob) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId} | Cancel One Restore Job of One Cluster +[**CreateBackupExportJob**](CloudBackupsApi.md#CreateBackupExportJob) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports | Create One Cloud Backup Snapshot Export Job +[**CreateBackupRestoreJob**](CloudBackupsApi.md#CreateBackupRestoreJob) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs | Restore One Snapshot of One Cluster +[**CreateExportBucket**](CloudBackupsApi.md#CreateExportBucket) | **Post** /api/atlas/v2/groups/{groupId}/backup/exportBuckets | Grant Access to AWS S3 Bucket for Cloud Backup Snapshot Exports +[**CreateServerlessBackupRestoreJob**](CloudBackupsApi.md#CreateServerlessBackupRestoreJob) | **Post** /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs | Restore One Snapshot of One Serverless Instance +[**DeleteAllBackupSchedules**](CloudBackupsApi.md#DeleteAllBackupSchedules) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule | Remove All Cloud Backup Schedules +[**DeleteExportBucket**](CloudBackupsApi.md#DeleteExportBucket) | **Delete** /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} | Revoke Access to AWS S3 Bucket for Cloud Backup Snapshot Exports +[**DeleteReplicaSetBackup**](CloudBackupsApi.md#DeleteReplicaSetBackup) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} | Remove One Replica Set Cloud Backup +[**DeleteShardedClusterBackup**](CloudBackupsApi.md#DeleteShardedClusterBackup) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId} | Remove One Sharded Cluster Cloud Backup +[**GetBackupExportJob**](CloudBackupsApi.md#GetBackupExportJob) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId} | Return One Cloud Backup Snapshot Export Job +[**GetBackupRestoreJob**](CloudBackupsApi.md#GetBackupRestoreJob) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId} | Return One Restore Job of One Cluster +[**GetBackupSchedule**](CloudBackupsApi.md#GetBackupSchedule) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule | Return One Cloud Backup Schedule +[**GetDataProtectionSettings**](CloudBackupsApi.md#GetDataProtectionSettings) | **Get** /api/atlas/v2/groups/{groupId}/backupCompliancePolicy | Return the Backup Compliance Policy settings +[**GetExportBucket**](CloudBackupsApi.md#GetExportBucket) | **Get** /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} | Return One AWS S3 Bucket Used for Cloud Backup Snapshot Exports +[**GetReplicaSetBackup**](CloudBackupsApi.md#GetReplicaSetBackup) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} | Return One Replica Set Cloud Backup +[**GetServerlessBackup**](CloudBackupsApi.md#GetServerlessBackup) | **Get** /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId} | Return One Snapshot of One Serverless Instance +[**GetServerlessBackupRestoreJob**](CloudBackupsApi.md#GetServerlessBackupRestoreJob) | **Get** /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId} | Return One Restore Job for One Serverless Instance +[**GetShardedClusterBackup**](CloudBackupsApi.md#GetShardedClusterBackup) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId} | Return One Sharded Cluster Cloud Backup +[**ListBackupExportJobs**](CloudBackupsApi.md#ListBackupExportJobs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports | Return All Cloud Backup Snapshot Export Jobs +[**ListBackupRestoreJobs**](CloudBackupsApi.md#ListBackupRestoreJobs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs | Return All Restore Jobs for One Cluster +[**ListExportBuckets**](CloudBackupsApi.md#ListExportBuckets) | **Get** /api/atlas/v2/groups/{groupId}/backup/exportBuckets | Return All AWS S3 Buckets Used for Cloud Backup Snapshot Exports +[**ListReplicaSetBackups**](CloudBackupsApi.md#ListReplicaSetBackups) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots | Return All Replica Set Cloud Backups +[**ListServerlessBackupRestoreJobs**](CloudBackupsApi.md#ListServerlessBackupRestoreJobs) | **Get** /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs | Return All Restore Jobs for One Serverless Instance +[**ListServerlessBackups**](CloudBackupsApi.md#ListServerlessBackups) | **Get** /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots | Return All Snapshots of One Serverless Instance +[**ListShardedClusterBackups**](CloudBackupsApi.md#ListShardedClusterBackups) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters | Return All Sharded Cluster Cloud Backups +[**TakeSnapshot**](CloudBackupsApi.md#TakeSnapshot) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots | Take One On-Demand Snapshot +[**UpdateBackupSchedule**](CloudBackupsApi.md#UpdateBackupSchedule) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule | Update Cloud Backup Schedule for One Cluster +[**UpdateDataProtectionSettings**](CloudBackupsApi.md#UpdateDataProtectionSettings) | **Put** /api/atlas/v2/groups/{groupId}/backupCompliancePolicy | Update or enable the Backup Compliance Policy settings +[**UpdateSnapshotRetention**](CloudBackupsApi.md#UpdateSnapshotRetention) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} | Change Expiration Date for One Cloud Backup + + + +## CancelBackupRestoreJob + +> CancelBackupRestoreJob(ctx, groupId, clusterName, restoreJobId).Execute() + +Cancel One Restore Job of One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + restoreJobId := "restoreJobId_example" // string | + + r, err := sdk.CloudBackupsApi.CancelBackupRestoreJob(context.Background(), groupId, clusterName, restoreJobId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.CancelBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**restoreJobId** | **string** | Unique 24-hexadecimal digit string that identifies the restore job to remove. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateBackupExportJob + +> DiskBackupExportJob CreateBackupExportJob(ctx, groupId, clusterName).DiskBackupExportJobRequest(diskBackupExportJobRequest).Execute() + +Create One Cloud Backup Snapshot Export Job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + diskBackupExportJobRequest := *openapiclient.NewDiskBackupExportJobRequest("32b6e34b3d91647abb20e7b8", "32b6e34b3d91647abb20e7b8") // DiskBackupExportJobRequest | + + resp, r, err := sdk.CloudBackupsApi.CreateBackupExportJob(context.Background(), groupId, clusterName).DiskBackupExportJobRequest(diskBackupExportJobRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.CreateBackupExportJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateBackupExportJob`: DiskBackupExportJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.CreateBackupExportJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateBackupExportJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **diskBackupExportJobRequest** | [**DiskBackupExportJobRequest**](DiskBackupExportJobRequest.md) | Information about the Cloud Backup Snapshot Export Job to create. | + +### Return type + +[**DiskBackupExportJob**](DiskBackupExportJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateBackupRestoreJob + +> DiskBackupRestoreJob CreateBackupRestoreJob(ctx, groupId, clusterName).DiskBackupRestoreJob(diskBackupRestoreJob).Execute() + +Restore One Snapshot of One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + diskBackupRestoreJob := *openapiclient.NewDiskBackupRestoreJob("DeliveryType_example", "TargetClusterName_example", "32b6e34b3d91647abb20e7b8") // DiskBackupRestoreJob | + + resp, r, err := sdk.CloudBackupsApi.CreateBackupRestoreJob(context.Background(), groupId, clusterName).DiskBackupRestoreJob(diskBackupRestoreJob).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.CreateBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateBackupRestoreJob`: DiskBackupRestoreJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.CreateBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **diskBackupRestoreJob** | [**DiskBackupRestoreJob**](DiskBackupRestoreJob.md) | Restores one snapshot of one cluster from the specified project. | + +### Return type + +[**DiskBackupRestoreJob**](DiskBackupRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateExportBucket + +> DiskBackupSnapshotAWSExportBucket CreateExportBucket(ctx, groupId).DiskBackupSnapshotAWSExportBucket(diskBackupSnapshotAWSExportBucket).Execute() + +Grant Access to AWS S3 Bucket for Cloud Backup Snapshot Exports + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + diskBackupSnapshotAWSExportBucket := *openapiclient.NewDiskBackupSnapshotAWSExportBucket() // DiskBackupSnapshotAWSExportBucket | + + resp, r, err := sdk.CloudBackupsApi.CreateExportBucket(context.Background(), groupId).DiskBackupSnapshotAWSExportBucket(diskBackupSnapshotAWSExportBucket).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.CreateExportBucket``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateExportBucket`: DiskBackupSnapshotAWSExportBucket + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.CreateExportBucket`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateExportBucketRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **diskBackupSnapshotAWSExportBucket** | [**DiskBackupSnapshotAWSExportBucket**](DiskBackupSnapshotAWSExportBucket.md) | Grants MongoDB Cloud access to the specified AWS S3 bucket. | + +### Return type + +[**DiskBackupSnapshotAWSExportBucket**](DiskBackupSnapshotAWSExportBucket.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateServerlessBackupRestoreJob + +> ServerlessBackupRestoreJob CreateServerlessBackupRestoreJob(ctx, groupId, clusterName).ServerlessBackupRestoreJob(serverlessBackupRestoreJob).Execute() + +Restore One Snapshot of One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + serverlessBackupRestoreJob := *openapiclient.NewServerlessBackupRestoreJob("DeliveryType_example", "TargetClusterName_example", "32b6e34b3d91647abb20e7b8") // ServerlessBackupRestoreJob | + + resp, r, err := sdk.CloudBackupsApi.CreateServerlessBackupRestoreJob(context.Background(), groupId, clusterName).ServerlessBackupRestoreJob(serverlessBackupRestoreJob).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.CreateServerlessBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateServerlessBackupRestoreJob`: ServerlessBackupRestoreJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.CreateServerlessBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the serverless instance whose snapshot you want to restore. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServerlessBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **serverlessBackupRestoreJob** | [**ServerlessBackupRestoreJob**](ServerlessBackupRestoreJob.md) | Restores one snapshot of one serverless instance from the specified project. | + +### Return type + +[**ServerlessBackupRestoreJob**](ServerlessBackupRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteAllBackupSchedules + +> DiskBackupSnapshotSchedule DeleteAllBackupSchedules(ctx, groupId, clusterName).Execute() + +Remove All Cloud Backup Schedules + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.CloudBackupsApi.DeleteAllBackupSchedules(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.DeleteAllBackupSchedules``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DeleteAllBackupSchedules`: DiskBackupSnapshotSchedule + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.DeleteAllBackupSchedules`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAllBackupSchedulesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**DiskBackupSnapshotSchedule**](DiskBackupSnapshotSchedule.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteExportBucket + +> DeleteExportBucket(ctx, groupId, exportBucketId).Execute() + +Revoke Access to AWS S3 Bucket for Cloud Backup Snapshot Exports + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + exportBucketId := "exportBucketId_example" // string | + + r, err := sdk.CloudBackupsApi.DeleteExportBucket(context.Background(), groupId, exportBucketId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.DeleteExportBucket``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**exportBucketId** | **string** | Unique string that identifies the AWS S3 bucket to which you export your snapshots. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteExportBucketRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteReplicaSetBackup + +> DeleteReplicaSetBackup(ctx, groupId, clusterName, snapshotId).Execute() + +Remove One Replica Set Cloud Backup + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + + r, err := sdk.CloudBackupsApi.DeleteReplicaSetBackup(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.DeleteReplicaSetBackup``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteReplicaSetBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteShardedClusterBackup + +> DeleteShardedClusterBackup(ctx, groupId, clusterName, snapshotId).Execute() + +Remove One Sharded Cluster Cloud Backup + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + + r, err := sdk.CloudBackupsApi.DeleteShardedClusterBackup(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.DeleteShardedClusterBackup``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteShardedClusterBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetBackupExportJob + +> DiskBackupExportJob GetBackupExportJob(ctx, groupId, clusterName, exportId).Execute() + +Return One Cloud Backup Snapshot Export Job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + exportId := "exportId_example" // string | + + resp, r, err := sdk.CloudBackupsApi.GetBackupExportJob(context.Background(), groupId, clusterName, exportId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetBackupExportJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetBackupExportJob`: DiskBackupExportJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetBackupExportJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**exportId** | **string** | Unique string that identifies the AWS S3 bucket to which you export your snapshots. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBackupExportJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**DiskBackupExportJob**](DiskBackupExportJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetBackupRestoreJob + +> DiskBackupRestoreJob GetBackupRestoreJob(ctx, groupId, clusterName, restoreJobId).Execute() + +Return One Restore Job of One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + restoreJobId := "restoreJobId_example" // string | + + resp, r, err := sdk.CloudBackupsApi.GetBackupRestoreJob(context.Background(), groupId, clusterName, restoreJobId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetBackupRestoreJob`: DiskBackupRestoreJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster with the restore jobs you want to return. | +**restoreJobId** | **string** | Unique 24-hexadecimal digit string that identifies the restore job to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**DiskBackupRestoreJob**](DiskBackupRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetBackupSchedule + +> DiskBackupSnapshotSchedule GetBackupSchedule(ctx, groupId, clusterName).Execute() + +Return One Cloud Backup Schedule + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.CloudBackupsApi.GetBackupSchedule(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetBackupSchedule``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetBackupSchedule`: DiskBackupSnapshotSchedule + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetBackupSchedule`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBackupScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**DiskBackupSnapshotSchedule**](DiskBackupSnapshotSchedule.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetDataProtectionSettings + +> DataProtectionSettings GetDataProtectionSettings(ctx, groupId).Execute() + +Return the Backup Compliance Policy settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.CloudBackupsApi.GetDataProtectionSettings(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetDataProtectionSettings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetDataProtectionSettings`: DataProtectionSettings + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetDataProtectionSettings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataProtectionSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**DataProtectionSettings**](DataProtectionSettings.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetExportBucket + +> DiskBackupSnapshotAWSExportBucket GetExportBucket(ctx, groupId, exportBucketId).Execute() + +Return One AWS S3 Bucket Used for Cloud Backup Snapshot Exports + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + exportBucketId := "exportBucketId_example" // string | + + resp, r, err := sdk.CloudBackupsApi.GetExportBucket(context.Background(), groupId, exportBucketId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetExportBucket``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetExportBucket`: DiskBackupSnapshotAWSExportBucket + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetExportBucket`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**exportBucketId** | **string** | Unique string that identifies the AWS S3 bucket to which you export your snapshots. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetExportBucketRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**DiskBackupSnapshotAWSExportBucket**](DiskBackupSnapshotAWSExportBucket.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetReplicaSetBackup + +> DiskBackupReplicaSet GetReplicaSetBackup(ctx, groupId, clusterName, snapshotId).Execute() + +Return One Replica Set Cloud Backup + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + + resp, r, err := sdk.CloudBackupsApi.GetReplicaSetBackup(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetReplicaSetBackup``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetReplicaSetBackup`: DiskBackupReplicaSet + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetReplicaSetBackup`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReplicaSetBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**DiskBackupReplicaSet**](DiskBackupReplicaSet.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerlessBackup + +> ServerlessBackupSnapshot GetServerlessBackup(ctx, groupId, clusterName, snapshotId).Execute() + +Return One Snapshot of One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.CloudBackupsApi.GetServerlessBackup(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetServerlessBackup``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetServerlessBackup`: ServerlessBackupSnapshot + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetServerlessBackup`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the serverless instance. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerlessBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**ServerlessBackupSnapshot**](ServerlessBackupSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerlessBackupRestoreJob + +> ServerlessBackupRestoreJob GetServerlessBackupRestoreJob(ctx, groupId, clusterName, restoreJobId).Execute() + +Return One Restore Job for One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + restoreJobId := "restoreJobId_example" // string | + + resp, r, err := sdk.CloudBackupsApi.GetServerlessBackupRestoreJob(context.Background(), groupId, clusterName, restoreJobId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetServerlessBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetServerlessBackupRestoreJob`: ServerlessBackupRestoreJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetServerlessBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the serverless instance. | +**restoreJobId** | **string** | Unique 24-hexadecimal digit string that identifies the restore job to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerlessBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**ServerlessBackupRestoreJob**](ServerlessBackupRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetShardedClusterBackup + +> DiskBackupShardedClusterSnapshot GetShardedClusterBackup(ctx, groupId, clusterName, snapshotId).Execute() + +Return One Sharded Cluster Cloud Backup + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + + resp, r, err := sdk.CloudBackupsApi.GetShardedClusterBackup(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.GetShardedClusterBackup``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetShardedClusterBackup`: DiskBackupShardedClusterSnapshot + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.GetShardedClusterBackup`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetShardedClusterBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**DiskBackupShardedClusterSnapshot**](DiskBackupShardedClusterSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListBackupExportJobs + +> PaginatedApiAtlasDiskBackupExportJob ListBackupExportJobs(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Cloud Backup Snapshot Export Jobs + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.CloudBackupsApi.ListBackupExportJobs(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.ListBackupExportJobs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListBackupExportJobs`: PaginatedApiAtlasDiskBackupExportJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.ListBackupExportJobs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListBackupExportJobsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiAtlasDiskBackupExportJob**](PaginatedApiAtlasDiskBackupExportJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListBackupRestoreJobs + +> PaginatedCloudBackupRestoreJob ListBackupRestoreJobs(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Restore Jobs for One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.CloudBackupsApi.ListBackupRestoreJobs(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.ListBackupRestoreJobs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListBackupRestoreJobs`: PaginatedCloudBackupRestoreJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.ListBackupRestoreJobs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster with the restore jobs you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListBackupRestoreJobsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedCloudBackupRestoreJob**](PaginatedCloudBackupRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListExportBuckets + +> PaginatedBackupSnapshotExportBucket ListExportBuckets(ctx, groupId).Execute() + +Return All AWS S3 Buckets Used for Cloud Backup Snapshot Exports + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.CloudBackupsApi.ListExportBuckets(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.ListExportBuckets``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListExportBuckets`: PaginatedBackupSnapshotExportBucket + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.ListExportBuckets`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListExportBucketsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PaginatedBackupSnapshotExportBucket**](PaginatedBackupSnapshotExportBucket.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListReplicaSetBackups + +> PaginatedCloudBackupReplicaSet ListReplicaSetBackups(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Replica Set Cloud Backups + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.CloudBackupsApi.ListReplicaSetBackups(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.ListReplicaSetBackups``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListReplicaSetBackups`: PaginatedCloudBackupReplicaSet + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.ListReplicaSetBackups`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListReplicaSetBackupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedCloudBackupReplicaSet**](PaginatedCloudBackupReplicaSet.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListServerlessBackupRestoreJobs + +> PaginatedApiAtlasServerlessBackupRestoreJob ListServerlessBackupRestoreJobs(ctx, groupId, clusterName).Execute() + +Return All Restore Jobs for One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.CloudBackupsApi.ListServerlessBackupRestoreJobs(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.ListServerlessBackupRestoreJobs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListServerlessBackupRestoreJobs`: PaginatedApiAtlasServerlessBackupRestoreJob + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.ListServerlessBackupRestoreJobs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the serverless instance. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListServerlessBackupRestoreJobsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**PaginatedApiAtlasServerlessBackupRestoreJob**](PaginatedApiAtlasServerlessBackupRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListServerlessBackups + +> PaginatedApiAtlasServerlessBackupSnapshot ListServerlessBackups(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Snapshots of One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.CloudBackupsApi.ListServerlessBackups(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.ListServerlessBackups``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListServerlessBackups`: PaginatedApiAtlasServerlessBackupSnapshot + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.ListServerlessBackups`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the serverless instance. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListServerlessBackupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiAtlasServerlessBackupSnapshot**](PaginatedApiAtlasServerlessBackupSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListShardedClusterBackups + +> PaginatedCloudBackupShardedClusterSnapshot ListShardedClusterBackups(ctx, groupId, clusterName).Execute() + +Return All Sharded Cluster Cloud Backups + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.CloudBackupsApi.ListShardedClusterBackups(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.ListShardedClusterBackups``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListShardedClusterBackups`: PaginatedCloudBackupShardedClusterSnapshot + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.ListShardedClusterBackups`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListShardedClusterBackupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**PaginatedCloudBackupShardedClusterSnapshot**](PaginatedCloudBackupShardedClusterSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TakeSnapshot + +> DiskBackupSnapshot TakeSnapshot(ctx, groupId, clusterName).DiskBackupOnDemandSnapshotRequest(diskBackupOnDemandSnapshotRequest).Execute() + +Take One On-Demand Snapshot + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + diskBackupOnDemandSnapshotRequest := *openapiclient.NewDiskBackupOnDemandSnapshotRequest() // DiskBackupOnDemandSnapshotRequest | + + resp, r, err := sdk.CloudBackupsApi.TakeSnapshot(context.Background(), groupId, clusterName).DiskBackupOnDemandSnapshotRequest(diskBackupOnDemandSnapshotRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.TakeSnapshot``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `TakeSnapshot`: DiskBackupSnapshot + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.TakeSnapshot`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTakeSnapshotRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **diskBackupOnDemandSnapshotRequest** | [**DiskBackupOnDemandSnapshotRequest**](DiskBackupOnDemandSnapshotRequest.md) | Takes one on-demand snapshot. | + +### Return type + +[**DiskBackupSnapshot**](DiskBackupSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateBackupSchedule + +> DiskBackupSnapshotSchedule UpdateBackupSchedule(ctx, groupId, clusterName).DiskBackupSnapshotSchedule(diskBackupSnapshotSchedule).Execute() + +Update Cloud Backup Schedule for One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + diskBackupSnapshotSchedule := *openapiclient.NewDiskBackupSnapshotSchedule() // DiskBackupSnapshotSchedule | + + resp, r, err := sdk.CloudBackupsApi.UpdateBackupSchedule(context.Background(), groupId, clusterName).DiskBackupSnapshotSchedule(diskBackupSnapshotSchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.UpdateBackupSchedule``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateBackupSchedule`: DiskBackupSnapshotSchedule + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.UpdateBackupSchedule`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateBackupScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **diskBackupSnapshotSchedule** | [**DiskBackupSnapshotSchedule**](DiskBackupSnapshotSchedule.md) | Updates the cloud backup schedule for one cluster within the specified project. **Note**: In the request body, provide only the fields that you want to update. | + +### Return type + +[**DiskBackupSnapshotSchedule**](DiskBackupSnapshotSchedule.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateDataProtectionSettings + +> DataProtectionSettings UpdateDataProtectionSettings(ctx, groupId).DataProtectionSettings(dataProtectionSettings).Execute() + +Update or enable the Backup Compliance Policy settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + dataProtectionSettings := *openapiclient.NewDataProtectionSettings() // DataProtectionSettings | + + resp, r, err := sdk.CloudBackupsApi.UpdateDataProtectionSettings(context.Background(), groupId).DataProtectionSettings(dataProtectionSettings).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.UpdateDataProtectionSettings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateDataProtectionSettings`: DataProtectionSettings + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.UpdateDataProtectionSettings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateDataProtectionSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **dataProtectionSettings** | [**DataProtectionSettings**](DataProtectionSettings.md) | The new Backup Compliance Policy settings. | + +### Return type + +[**DataProtectionSettings**](DataProtectionSettings.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateSnapshotRetention + +> DiskBackupReplicaSet UpdateSnapshotRetention(ctx, groupId, clusterName, snapshotId).SnapshotRetention(snapshotRetention).Execute() + +Change Expiration Date for One Cloud Backup + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + snapshotRetention := *openapiclient.NewSnapshotRetention("RetentionUnit_example", int(5)) // SnapshotRetention | + + resp, r, err := sdk.CloudBackupsApi.UpdateSnapshotRetention(context.Background(), groupId, clusterName, snapshotId).SnapshotRetention(snapshotRetention).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudBackupsApi.UpdateSnapshotRetention``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateSnapshotRetention`: DiskBackupReplicaSet + fmt.Fprintf(os.Stdout, "Response from `CloudBackupsApi.UpdateSnapshotRetention`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSnapshotRetentionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **snapshotRetention** | [**SnapshotRetention**](SnapshotRetention.md) | Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. | + +### Return type + +[**DiskBackupReplicaSet**](DiskBackupReplicaSet.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/CloudMigrationServiceApi.md b/docs/docs/CloudMigrationServiceApi.md new file mode 100644 index 00000000..4cfdfea4 --- /dev/null +++ b/docs/docs/CloudMigrationServiceApi.md @@ -0,0 +1,619 @@ +# \CloudMigrationServiceApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateLinkToken**](CloudMigrationServiceApi.md#CreateLinkToken) | **Post** /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens | Create One Link-Token +[**CreatePushMigration**](CloudMigrationServiceApi.md#CreatePushMigration) | **Post** /api/atlas/v2/groups/{groupId}/liveMigrations | Migrate One Local Managed Cluster to MongoDB Atlas +[**CutoverMigration**](CloudMigrationServiceApi.md#CutoverMigration) | **Put** /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover | Cut Over the Migrated Cluster +[**DeleteLinkToken**](CloudMigrationServiceApi.md#DeleteLinkToken) | **Delete** /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens | Remove One Link-Token +[**GetPushMigration**](CloudMigrationServiceApi.md#GetPushMigration) | **Get** /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId} | Return One Migration Job +[**GetValidationStatus**](CloudMigrationServiceApi.md#GetValidationStatus) | **Get** /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId} | Return One Migration Validation Job +[**ListSourceProjects**](CloudMigrationServiceApi.md#ListSourceProjects) | **Get** /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects | Return All Projects Available for Migration +[**ValidateMigration**](CloudMigrationServiceApi.md#ValidateMigration) | **Post** /api/atlas/v2/groups/{groupId}/liveMigrations/validate | Validate One Migration Request + + + +## CreateLinkToken + +> TargetOrg CreateLinkToken(ctx, orgId).TargetOrgRequest(targetOrgRequest).Execute() + +Create One Link-Token + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + targetOrgRequest := *openapiclient.NewTargetOrgRequest() // TargetOrgRequest | + + resp, r, err := sdk.CloudMigrationServiceApi.CreateLinkToken(context.Background(), orgId).TargetOrgRequest(targetOrgRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.CreateLinkToken``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateLinkToken`: TargetOrg + fmt.Fprintf(os.Stdout, "Response from `CloudMigrationServiceApi.CreateLinkToken`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateLinkTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **targetOrgRequest** | [**TargetOrgRequest**](TargetOrgRequest.md) | IP address access list entries associated with the migration. | + +### Return type + +[**TargetOrg**](TargetOrg.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreatePushMigration + +> LiveMigrationResponse CreatePushMigration(ctx, groupId).LiveMigrationRequest(liveMigrationRequest).Execute() + +Migrate One Local Managed Cluster to MongoDB Atlas + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + liveMigrationRequest := *openapiclient.NewLiveMigrationRequest(*openapiclient.NewDestination("ClusterName_example", "9b43a5b329223c3a1591a678", "HostnameSchemaType_example"), false, *openapiclient.NewSource("ClusterName_example", "9b43a5b329223c3a1591a678", false, false)) // LiveMigrationRequest | + + resp, r, err := sdk.CloudMigrationServiceApi.CreatePushMigration(context.Background(), groupId).LiveMigrationRequest(liveMigrationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.CreatePushMigration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreatePushMigration`: LiveMigrationResponse + fmt.Fprintf(os.Stdout, "Response from `CloudMigrationServiceApi.CreatePushMigration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePushMigrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **liveMigrationRequest** | [**LiveMigrationRequest**](LiveMigrationRequest.md) | One migration to be created. | + +### Return type + +[**LiveMigrationResponse**](LiveMigrationResponse.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CutoverMigration + +> CutoverMigration(ctx, groupId, liveMigrationId).Execute() + +Cut Over the Migrated Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + liveMigrationId := "6296fb4c7c7aa997cf94e9a8" // string | + + r, err := sdk.CloudMigrationServiceApi.CutoverMigration(context.Background(), groupId, liveMigrationId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.CutoverMigration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**liveMigrationId** | **string** | Unique 24-hexadecimal digit string that identifies the migration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCutoverMigrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteLinkToken + +> DeleteLinkToken(ctx, orgId).Execute() + +Remove One Link-Token + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + + r, err := sdk.CloudMigrationServiceApi.DeleteLinkToken(context.Background(), orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.DeleteLinkToken``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLinkTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPushMigration + +> LiveMigrationResponse GetPushMigration(ctx, groupId, liveMigrationId).Execute() + +Return One Migration Job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + liveMigrationId := "6296fb4c7c7aa997cf94e9a8" // string | + + resp, r, err := sdk.CloudMigrationServiceApi.GetPushMigration(context.Background(), groupId, liveMigrationId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.GetPushMigration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetPushMigration`: LiveMigrationResponse + fmt.Fprintf(os.Stdout, "Response from `CloudMigrationServiceApi.GetPushMigration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**liveMigrationId** | **string** | Unique 24-hexadecimal digit string that identifies the migration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPushMigrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LiveMigrationResponse**](LiveMigrationResponse.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetValidationStatus + +> Validation GetValidationStatus(ctx, groupId, validationId).Execute() + +Return One Migration Validation Job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + validationId := "507f1f77bcf86cd799439011" // string | + + resp, r, err := sdk.CloudMigrationServiceApi.GetValidationStatus(context.Background(), groupId, validationId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.GetValidationStatus``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetValidationStatus`: Validation + fmt.Fprintf(os.Stdout, "Response from `CloudMigrationServiceApi.GetValidationStatus`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**validationId** | **string** | Unique 24-hexadecimal digit string that identifies the validation job. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetValidationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Validation**](Validation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListSourceProjects + +> []AvailableProject ListSourceProjects(ctx, orgId).Execute() + +Return All Projects Available for Migration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + + resp, r, err := sdk.CloudMigrationServiceApi.ListSourceProjects(context.Background(), orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.ListSourceProjects``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListSourceProjects`: []AvailableProject + fmt.Fprintf(os.Stdout, "Response from `CloudMigrationServiceApi.ListSourceProjects`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSourceProjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]AvailableProject**](AvailableProject.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ValidateMigration + +> Validation ValidateMigration(ctx, groupId).LiveMigrationRequest(liveMigrationRequest).Execute() + +Validate One Migration Request + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + liveMigrationRequest := *openapiclient.NewLiveMigrationRequest(*openapiclient.NewDestination("ClusterName_example", "9b43a5b329223c3a1591a678", "HostnameSchemaType_example"), false, *openapiclient.NewSource("ClusterName_example", "9b43a5b329223c3a1591a678", false, false)) // LiveMigrationRequest | + + resp, r, err := sdk.CloudMigrationServiceApi.ValidateMigration(context.Background(), groupId).LiveMigrationRequest(liveMigrationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudMigrationServiceApi.ValidateMigration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ValidateMigration`: Validation + fmt.Fprintf(os.Stdout, "Response from `CloudMigrationServiceApi.ValidateMigration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiValidateMigrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **liveMigrationRequest** | [**LiveMigrationRequest**](LiveMigrationRequest.md) | One migration to be validated. | + +### Return type + +[**Validation**](Validation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/CloudProviderAccess.md b/docs/docs/CloudProviderAccess.md new file mode 100644 index 00000000..0f7b5e91 --- /dev/null +++ b/docs/docs/CloudProviderAccess.md @@ -0,0 +1,56 @@ +# CloudProviderAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsIamRoles** | Pointer to [**[]CloudProviderAccessAWSIAMRole**](CloudProviderAccessAWSIAMRole.md) | List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud. | [optional] + +## Methods + +### NewCloudProviderAccess + +`func NewCloudProviderAccess() *CloudProviderAccess` + +NewCloudProviderAccess instantiates a new CloudProviderAccess object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessWithDefaults + +`func NewCloudProviderAccessWithDefaults() *CloudProviderAccess` + +NewCloudProviderAccessWithDefaults instantiates a new CloudProviderAccess object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAwsIamRoles + +`func (o *CloudProviderAccess) GetAwsIamRoles() []CloudProviderAccessAWSIAMRole` + +GetAwsIamRoles returns the AwsIamRoles field if non-nil, zero value otherwise. + +### GetAwsIamRolesOk + +`func (o *CloudProviderAccess) GetAwsIamRolesOk() (*[]CloudProviderAccessAWSIAMRole, bool)` + +GetAwsIamRolesOk returns a tuple with the AwsIamRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsIamRoles + +`func (o *CloudProviderAccess) SetAwsIamRoles(v []CloudProviderAccessAWSIAMRole)` + +SetAwsIamRoles sets AwsIamRoles field to given value. + +### HasAwsIamRoles + +`func (o *CloudProviderAccess) HasAwsIamRoles() bool` + +HasAwsIamRoles returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessAWSIAMRole.md b/docs/docs/CloudProviderAccessAWSIAMRole.md new file mode 100644 index 00000000..d348eaeb --- /dev/null +++ b/docs/docs/CloudProviderAccessAWSIAMRole.md @@ -0,0 +1,233 @@ +# CloudProviderAccessAWSIAMRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AtlasAWSAccountArn** | Pointer to **string** | Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role. | [optional] [readonly] +**AtlasAssumedRoleExternalId** | Pointer to **string** | Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account. | [optional] [readonly] +**AuthorizedDate** | Pointer to **time.Time** | Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**CreatedDate** | Pointer to **time.Time** | Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FeatureUsages** | Pointer to [**[]CloudProviderAccessFeatureUsage**](CloudProviderAccessFeatureUsage.md) | List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role. | [optional] [readonly] +**IamAssumedRoleArn** | Pointer to **string** | Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account. | [optional] +**RoleId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the role. | [optional] [readonly] +**ProviderName** | **string** | Human-readable label that identifies the cloud provider of the role. | + +## Methods + +### NewCloudProviderAccessAWSIAMRole + +`func NewCloudProviderAccessAWSIAMRole(providerName string, ) *CloudProviderAccessAWSIAMRole` + +NewCloudProviderAccessAWSIAMRole instantiates a new CloudProviderAccessAWSIAMRole object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessAWSIAMRoleWithDefaults + +`func NewCloudProviderAccessAWSIAMRoleWithDefaults() *CloudProviderAccessAWSIAMRole` + +NewCloudProviderAccessAWSIAMRoleWithDefaults instantiates a new CloudProviderAccessAWSIAMRole object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAtlasAWSAccountArn + +`func (o *CloudProviderAccessAWSIAMRole) GetAtlasAWSAccountArn() string` + +GetAtlasAWSAccountArn returns the AtlasAWSAccountArn field if non-nil, zero value otherwise. + +### GetAtlasAWSAccountArnOk + +`func (o *CloudProviderAccessAWSIAMRole) GetAtlasAWSAccountArnOk() (*string, bool)` + +GetAtlasAWSAccountArnOk returns a tuple with the AtlasAWSAccountArn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasAWSAccountArn + +`func (o *CloudProviderAccessAWSIAMRole) SetAtlasAWSAccountArn(v string)` + +SetAtlasAWSAccountArn sets AtlasAWSAccountArn field to given value. + +### HasAtlasAWSAccountArn + +`func (o *CloudProviderAccessAWSIAMRole) HasAtlasAWSAccountArn() bool` + +HasAtlasAWSAccountArn returns a boolean if a field has been set. + +### GetAtlasAssumedRoleExternalId + +`func (o *CloudProviderAccessAWSIAMRole) GetAtlasAssumedRoleExternalId() string` + +GetAtlasAssumedRoleExternalId returns the AtlasAssumedRoleExternalId field if non-nil, zero value otherwise. + +### GetAtlasAssumedRoleExternalIdOk + +`func (o *CloudProviderAccessAWSIAMRole) GetAtlasAssumedRoleExternalIdOk() (*string, bool)` + +GetAtlasAssumedRoleExternalIdOk returns a tuple with the AtlasAssumedRoleExternalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasAssumedRoleExternalId + +`func (o *CloudProviderAccessAWSIAMRole) SetAtlasAssumedRoleExternalId(v string)` + +SetAtlasAssumedRoleExternalId sets AtlasAssumedRoleExternalId field to given value. + +### HasAtlasAssumedRoleExternalId + +`func (o *CloudProviderAccessAWSIAMRole) HasAtlasAssumedRoleExternalId() bool` + +HasAtlasAssumedRoleExternalId returns a boolean if a field has been set. + +### GetAuthorizedDate + +`func (o *CloudProviderAccessAWSIAMRole) GetAuthorizedDate() time.Time` + +GetAuthorizedDate returns the AuthorizedDate field if non-nil, zero value otherwise. + +### GetAuthorizedDateOk + +`func (o *CloudProviderAccessAWSIAMRole) GetAuthorizedDateOk() (*time.Time, bool)` + +GetAuthorizedDateOk returns a tuple with the AuthorizedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizedDate + +`func (o *CloudProviderAccessAWSIAMRole) SetAuthorizedDate(v time.Time)` + +SetAuthorizedDate sets AuthorizedDate field to given value. + +### HasAuthorizedDate + +`func (o *CloudProviderAccessAWSIAMRole) HasAuthorizedDate() bool` + +HasAuthorizedDate returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *CloudProviderAccessAWSIAMRole) GetCreatedDate() time.Time` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *CloudProviderAccessAWSIAMRole) GetCreatedDateOk() (*time.Time, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *CloudProviderAccessAWSIAMRole) SetCreatedDate(v time.Time)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *CloudProviderAccessAWSIAMRole) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetFeatureUsages + +`func (o *CloudProviderAccessAWSIAMRole) GetFeatureUsages() []CloudProviderAccessFeatureUsage` + +GetFeatureUsages returns the FeatureUsages field if non-nil, zero value otherwise. + +### GetFeatureUsagesOk + +`func (o *CloudProviderAccessAWSIAMRole) GetFeatureUsagesOk() (*[]CloudProviderAccessFeatureUsage, bool)` + +GetFeatureUsagesOk returns a tuple with the FeatureUsages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureUsages + +`func (o *CloudProviderAccessAWSIAMRole) SetFeatureUsages(v []CloudProviderAccessFeatureUsage)` + +SetFeatureUsages sets FeatureUsages field to given value. + +### HasFeatureUsages + +`func (o *CloudProviderAccessAWSIAMRole) HasFeatureUsages() bool` + +HasFeatureUsages returns a boolean if a field has been set. + +### GetIamAssumedRoleArn + +`func (o *CloudProviderAccessAWSIAMRole) GetIamAssumedRoleArn() string` + +GetIamAssumedRoleArn returns the IamAssumedRoleArn field if non-nil, zero value otherwise. + +### GetIamAssumedRoleArnOk + +`func (o *CloudProviderAccessAWSIAMRole) GetIamAssumedRoleArnOk() (*string, bool)` + +GetIamAssumedRoleArnOk returns a tuple with the IamAssumedRoleArn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIamAssumedRoleArn + +`func (o *CloudProviderAccessAWSIAMRole) SetIamAssumedRoleArn(v string)` + +SetIamAssumedRoleArn sets IamAssumedRoleArn field to given value. + +### HasIamAssumedRoleArn + +`func (o *CloudProviderAccessAWSIAMRole) HasIamAssumedRoleArn() bool` + +HasIamAssumedRoleArn returns a boolean if a field has been set. + +### GetRoleId + +`func (o *CloudProviderAccessAWSIAMRole) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *CloudProviderAccessAWSIAMRole) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *CloudProviderAccessAWSIAMRole) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *CloudProviderAccessAWSIAMRole) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *CloudProviderAccessAWSIAMRole) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *CloudProviderAccessAWSIAMRole) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *CloudProviderAccessAWSIAMRole) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessApi.md b/docs/docs/CloudProviderAccessApi.md new file mode 100644 index 00000000..ffc6c594 --- /dev/null +++ b/docs/docs/CloudProviderAccessApi.md @@ -0,0 +1,397 @@ +# \CloudProviderAccessApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AuthorizeCloudProviderAccessRole**](CloudProviderAccessApi.md#AuthorizeCloudProviderAccessRole) | **Patch** /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId} | Authorize One Cloud Provider Access Role +[**CreateCloudProviderAccessRole**](CloudProviderAccessApi.md#CreateCloudProviderAccessRole) | **Post** /api/atlas/v2/groups/{groupId}/cloudProviderAccess | Create One Cloud Provider Access Role +[**DeauthorizeCloudProviderAccessRole**](CloudProviderAccessApi.md#DeauthorizeCloudProviderAccessRole) | **Delete** /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId} | Deauthorize One Cloud Provider Access Role +[**GetCloudProviderAccessRole**](CloudProviderAccessApi.md#GetCloudProviderAccessRole) | **Get** /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId} | Return specified Cloud Provider Access Role +[**ListCloudProviderAccessRoles**](CloudProviderAccessApi.md#ListCloudProviderAccessRoles) | **Get** /api/atlas/v2/groups/{groupId}/cloudProviderAccess | Return All Cloud Provider Access Roles + + + +## AuthorizeCloudProviderAccessRole + +> CloudProviderAccessRole AuthorizeCloudProviderAccessRole(ctx, groupId, roleId).CloudProviderAccessRole(cloudProviderAccessRole).Execute() + +Authorize One Cloud Provider Access Role + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + roleId := "roleId_example" // string | + cloudProviderAccessRole := openapiclient.CloudProviderAccessRole{CloudProviderAccessAWSIAMRole: openapiclient.NewCloudProviderAccessAWSIAMRole("ProviderName_example")} // CloudProviderAccessRole | + + resp, r, err := sdk.CloudProviderAccessApi.AuthorizeCloudProviderAccessRole(context.Background(), groupId, roleId).CloudProviderAccessRole(cloudProviderAccessRole).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudProviderAccessApi.AuthorizeCloudProviderAccessRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `AuthorizeCloudProviderAccessRole`: CloudProviderAccessRole + fmt.Fprintf(os.Stdout, "Response from `CloudProviderAccessApi.AuthorizeCloudProviderAccessRole`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**roleId** | **string** | Unique 24-hexadecimal digit string that identifies the role. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAuthorizeCloudProviderAccessRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **cloudProviderAccessRole** | [**CloudProviderAccessRole**](CloudProviderAccessRole.md) | Grants access to the specified project for the specified AWS IAM role. | + +### Return type + +[**CloudProviderAccessRole**](CloudProviderAccessRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateCloudProviderAccessRole + +> CloudProviderAccessRole CreateCloudProviderAccessRole(ctx, groupId).CloudProviderAccessRole(cloudProviderAccessRole).Execute() + +Create One Cloud Provider Access Role + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProviderAccessRole := openapiclient.CloudProviderAccessRole{CloudProviderAccessAWSIAMRole: openapiclient.NewCloudProviderAccessAWSIAMRole("ProviderName_example")} // CloudProviderAccessRole | + + resp, r, err := sdk.CloudProviderAccessApi.CreateCloudProviderAccessRole(context.Background(), groupId).CloudProviderAccessRole(cloudProviderAccessRole).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudProviderAccessApi.CreateCloudProviderAccessRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateCloudProviderAccessRole`: CloudProviderAccessRole + fmt.Fprintf(os.Stdout, "Response from `CloudProviderAccessApi.CreateCloudProviderAccessRole`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCloudProviderAccessRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **cloudProviderAccessRole** | [**CloudProviderAccessRole**](CloudProviderAccessRole.md) | Creates one AWS IAM role. | + +### Return type + +[**CloudProviderAccessRole**](CloudProviderAccessRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeauthorizeCloudProviderAccessRole + +> DeauthorizeCloudProviderAccessRole(ctx, groupId, cloudProvider, roleId).Execute() + +Deauthorize One Cloud Provider Access Role + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProvider := "cloudProvider_example" // string | + roleId := "roleId_example" // string | + + r, err := sdk.CloudProviderAccessApi.DeauthorizeCloudProviderAccessRole(context.Background(), groupId, cloudProvider, roleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudProviderAccessApi.DeauthorizeCloudProviderAccessRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**cloudProvider** | **string** | Human-readable label that identifies the cloud provider of the role to deauthorize. | +**roleId** | **string** | Unique 24-hexadecimal digit string that identifies the role. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeauthorizeCloudProviderAccessRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetCloudProviderAccessRole + +> CloudProviderAccess GetCloudProviderAccessRole(ctx, groupId, roleId).Execute() + +Return specified Cloud Provider Access Role + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + roleId := "roleId_example" // string | + + resp, r, err := sdk.CloudProviderAccessApi.GetCloudProviderAccessRole(context.Background(), groupId, roleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudProviderAccessApi.GetCloudProviderAccessRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetCloudProviderAccessRole`: CloudProviderAccess + fmt.Fprintf(os.Stdout, "Response from `CloudProviderAccessApi.GetCloudProviderAccessRole`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**roleId** | **string** | Unique 24-hexadecimal digit string that identifies the role. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCloudProviderAccessRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**CloudProviderAccess**](CloudProviderAccess.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListCloudProviderAccessRoles + +> CloudProviderAccess ListCloudProviderAccessRoles(ctx, groupId).Execute() + +Return All Cloud Provider Access Roles + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.CloudProviderAccessApi.ListCloudProviderAccessRoles(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CloudProviderAccessApi.ListCloudProviderAccessRoles``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListCloudProviderAccessRoles`: CloudProviderAccess + fmt.Fprintf(os.Stdout, "Response from `CloudProviderAccessApi.ListCloudProviderAccessRoles`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCloudProviderAccessRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CloudProviderAccess**](CloudProviderAccess.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/CloudProviderAccessAzureServicePrincipal.md b/docs/docs/CloudProviderAccessAzureServicePrincipal.md new file mode 100644 index 00000000..a040c135 --- /dev/null +++ b/docs/docs/CloudProviderAccessAzureServicePrincipal.md @@ -0,0 +1,233 @@ +# CloudProviderAccessAzureServicePrincipal + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas. | [optional] [readonly] +**AtlasAzureAppId** | Pointer to **string** | Azure Active Directory Application ID of Atlas. | [optional] +**CreatedDate** | Pointer to **time.Time** | Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FeatureUsages** | Pointer to [**[]CloudProviderAccessFeatureUsage**](CloudProviderAccessFeatureUsage.md) | List that contains application features associated with this Azure Service Principal. | [optional] [readonly] +**LastUpdatedDate** | Pointer to **time.Time** | Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**ServicePrincipalId** | Pointer to **string** | UUID string that identifies the Azure Service Principal. | [optional] +**TenantId** | Pointer to **string** | UUID String that identifies the Azure Active Directory Tenant ID. | [optional] +**ProviderName** | **string** | Human-readable label that identifies the cloud provider of the role. | + +## Methods + +### NewCloudProviderAccessAzureServicePrincipal + +`func NewCloudProviderAccessAzureServicePrincipal(providerName string, ) *CloudProviderAccessAzureServicePrincipal` + +NewCloudProviderAccessAzureServicePrincipal instantiates a new CloudProviderAccessAzureServicePrincipal object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessAzureServicePrincipalWithDefaults + +`func NewCloudProviderAccessAzureServicePrincipalWithDefaults() *CloudProviderAccessAzureServicePrincipal` + +NewCloudProviderAccessAzureServicePrincipalWithDefaults instantiates a new CloudProviderAccessAzureServicePrincipal object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *CloudProviderAccessAzureServicePrincipal) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CloudProviderAccessAzureServicePrincipal) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CloudProviderAccessAzureServicePrincipal) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAtlasAzureAppId + +`func (o *CloudProviderAccessAzureServicePrincipal) GetAtlasAzureAppId() string` + +GetAtlasAzureAppId returns the AtlasAzureAppId field if non-nil, zero value otherwise. + +### GetAtlasAzureAppIdOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetAtlasAzureAppIdOk() (*string, bool)` + +GetAtlasAzureAppIdOk returns a tuple with the AtlasAzureAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasAzureAppId + +`func (o *CloudProviderAccessAzureServicePrincipal) SetAtlasAzureAppId(v string)` + +SetAtlasAzureAppId sets AtlasAzureAppId field to given value. + +### HasAtlasAzureAppId + +`func (o *CloudProviderAccessAzureServicePrincipal) HasAtlasAzureAppId() bool` + +HasAtlasAzureAppId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *CloudProviderAccessAzureServicePrincipal) GetCreatedDate() time.Time` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetCreatedDateOk() (*time.Time, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *CloudProviderAccessAzureServicePrincipal) SetCreatedDate(v time.Time)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *CloudProviderAccessAzureServicePrincipal) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetFeatureUsages + +`func (o *CloudProviderAccessAzureServicePrincipal) GetFeatureUsages() []CloudProviderAccessFeatureUsage` + +GetFeatureUsages returns the FeatureUsages field if non-nil, zero value otherwise. + +### GetFeatureUsagesOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetFeatureUsagesOk() (*[]CloudProviderAccessFeatureUsage, bool)` + +GetFeatureUsagesOk returns a tuple with the FeatureUsages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureUsages + +`func (o *CloudProviderAccessAzureServicePrincipal) SetFeatureUsages(v []CloudProviderAccessFeatureUsage)` + +SetFeatureUsages sets FeatureUsages field to given value. + +### HasFeatureUsages + +`func (o *CloudProviderAccessAzureServicePrincipal) HasFeatureUsages() bool` + +HasFeatureUsages returns a boolean if a field has been set. + +### GetLastUpdatedDate + +`func (o *CloudProviderAccessAzureServicePrincipal) GetLastUpdatedDate() time.Time` + +GetLastUpdatedDate returns the LastUpdatedDate field if non-nil, zero value otherwise. + +### GetLastUpdatedDateOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetLastUpdatedDateOk() (*time.Time, bool)` + +GetLastUpdatedDateOk returns a tuple with the LastUpdatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdatedDate + +`func (o *CloudProviderAccessAzureServicePrincipal) SetLastUpdatedDate(v time.Time)` + +SetLastUpdatedDate sets LastUpdatedDate field to given value. + +### HasLastUpdatedDate + +`func (o *CloudProviderAccessAzureServicePrincipal) HasLastUpdatedDate() bool` + +HasLastUpdatedDate returns a boolean if a field has been set. + +### GetServicePrincipalId + +`func (o *CloudProviderAccessAzureServicePrincipal) GetServicePrincipalId() string` + +GetServicePrincipalId returns the ServicePrincipalId field if non-nil, zero value otherwise. + +### GetServicePrincipalIdOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetServicePrincipalIdOk() (*string, bool)` + +GetServicePrincipalIdOk returns a tuple with the ServicePrincipalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServicePrincipalId + +`func (o *CloudProviderAccessAzureServicePrincipal) SetServicePrincipalId(v string)` + +SetServicePrincipalId sets ServicePrincipalId field to given value. + +### HasServicePrincipalId + +`func (o *CloudProviderAccessAzureServicePrincipal) HasServicePrincipalId() bool` + +HasServicePrincipalId returns a boolean if a field has been set. + +### GetTenantId + +`func (o *CloudProviderAccessAzureServicePrincipal) GetTenantId() string` + +GetTenantId returns the TenantId field if non-nil, zero value otherwise. + +### GetTenantIdOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetTenantIdOk() (*string, bool)` + +GetTenantIdOk returns a tuple with the TenantId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantId + +`func (o *CloudProviderAccessAzureServicePrincipal) SetTenantId(v string)` + +SetTenantId sets TenantId field to given value. + +### HasTenantId + +`func (o *CloudProviderAccessAzureServicePrincipal) HasTenantId() bool` + +HasTenantId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *CloudProviderAccessAzureServicePrincipal) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *CloudProviderAccessAzureServicePrincipal) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *CloudProviderAccessAzureServicePrincipal) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessDataLakeFeatureUsage.md b/docs/docs/CloudProviderAccessDataLakeFeatureUsage.md new file mode 100644 index 00000000..1dda7c12 --- /dev/null +++ b/docs/docs/CloudProviderAccessDataLakeFeatureUsage.md @@ -0,0 +1,82 @@ +# CloudProviderAccessDataLakeFeatureUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FeatureId** | Pointer to [**CloudProviderAccessFeatureUsageDataLakeFeatureId**](CloudProviderAccessFeatureUsageDataLakeFeatureId.md) | | [optional] +**FeatureType** | Pointer to **string** | Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. | [optional] [readonly] + +## Methods + +### NewCloudProviderAccessDataLakeFeatureUsage + +`func NewCloudProviderAccessDataLakeFeatureUsage() *CloudProviderAccessDataLakeFeatureUsage` + +NewCloudProviderAccessDataLakeFeatureUsage instantiates a new CloudProviderAccessDataLakeFeatureUsage object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessDataLakeFeatureUsageWithDefaults + +`func NewCloudProviderAccessDataLakeFeatureUsageWithDefaults() *CloudProviderAccessDataLakeFeatureUsage` + +NewCloudProviderAccessDataLakeFeatureUsageWithDefaults instantiates a new CloudProviderAccessDataLakeFeatureUsage object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFeatureId + +`func (o *CloudProviderAccessDataLakeFeatureUsage) GetFeatureId() CloudProviderAccessFeatureUsageDataLakeFeatureId` + +GetFeatureId returns the FeatureId field if non-nil, zero value otherwise. + +### GetFeatureIdOk + +`func (o *CloudProviderAccessDataLakeFeatureUsage) GetFeatureIdOk() (*CloudProviderAccessFeatureUsageDataLakeFeatureId, bool)` + +GetFeatureIdOk returns a tuple with the FeatureId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureId + +`func (o *CloudProviderAccessDataLakeFeatureUsage) SetFeatureId(v CloudProviderAccessFeatureUsageDataLakeFeatureId)` + +SetFeatureId sets FeatureId field to given value. + +### HasFeatureId + +`func (o *CloudProviderAccessDataLakeFeatureUsage) HasFeatureId() bool` + +HasFeatureId returns a boolean if a field has been set. + +### GetFeatureType + +`func (o *CloudProviderAccessDataLakeFeatureUsage) GetFeatureType() string` + +GetFeatureType returns the FeatureType field if non-nil, zero value otherwise. + +### GetFeatureTypeOk + +`func (o *CloudProviderAccessDataLakeFeatureUsage) GetFeatureTypeOk() (*string, bool)` + +GetFeatureTypeOk returns a tuple with the FeatureType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureType + +`func (o *CloudProviderAccessDataLakeFeatureUsage) SetFeatureType(v string)` + +SetFeatureType sets FeatureType field to given value. + +### HasFeatureType + +`func (o *CloudProviderAccessDataLakeFeatureUsage) HasFeatureType() bool` + +HasFeatureType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessEncryptionAtRestFeatureUsage.md b/docs/docs/CloudProviderAccessEncryptionAtRestFeatureUsage.md new file mode 100644 index 00000000..8e451ef4 --- /dev/null +++ b/docs/docs/CloudProviderAccessEncryptionAtRestFeatureUsage.md @@ -0,0 +1,92 @@ +# CloudProviderAccessEncryptionAtRestFeatureUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FeatureId** | Pointer to **map[string]interface{}** | Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value. | [optional] +**FeatureType** | Pointer to **string** | Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. | [optional] [readonly] + +## Methods + +### NewCloudProviderAccessEncryptionAtRestFeatureUsage + +`func NewCloudProviderAccessEncryptionAtRestFeatureUsage() *CloudProviderAccessEncryptionAtRestFeatureUsage` + +NewCloudProviderAccessEncryptionAtRestFeatureUsage instantiates a new CloudProviderAccessEncryptionAtRestFeatureUsage object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessEncryptionAtRestFeatureUsageWithDefaults + +`func NewCloudProviderAccessEncryptionAtRestFeatureUsageWithDefaults() *CloudProviderAccessEncryptionAtRestFeatureUsage` + +NewCloudProviderAccessEncryptionAtRestFeatureUsageWithDefaults instantiates a new CloudProviderAccessEncryptionAtRestFeatureUsage object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFeatureId + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) GetFeatureId() map[string]interface{}` + +GetFeatureId returns the FeatureId field if non-nil, zero value otherwise. + +### GetFeatureIdOk + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) GetFeatureIdOk() (*map[string]interface{}, bool)` + +GetFeatureIdOk returns a tuple with the FeatureId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureId + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) SetFeatureId(v map[string]interface{})` + +SetFeatureId sets FeatureId field to given value. + +### HasFeatureId + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) HasFeatureId() bool` + +HasFeatureId returns a boolean if a field has been set. + +### SetFeatureIdNil + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) SetFeatureIdNil(b bool)` + + SetFeatureIdNil sets the value for FeatureId to be an explicit nil + +### UnsetFeatureId +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) UnsetFeatureId()` + +UnsetFeatureId ensures that no value is present for FeatureId, not even an explicit nil +### GetFeatureType + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) GetFeatureType() string` + +GetFeatureType returns the FeatureType field if non-nil, zero value otherwise. + +### GetFeatureTypeOk + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) GetFeatureTypeOk() (*string, bool)` + +GetFeatureTypeOk returns a tuple with the FeatureType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureType + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) SetFeatureType(v string)` + +SetFeatureType sets FeatureType field to given value. + +### HasFeatureType + +`func (o *CloudProviderAccessEncryptionAtRestFeatureUsage) HasFeatureType() bool` + +HasFeatureType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessExportSnapshotFeatureUsage.md b/docs/docs/CloudProviderAccessExportSnapshotFeatureUsage.md new file mode 100644 index 00000000..918d7f12 --- /dev/null +++ b/docs/docs/CloudProviderAccessExportSnapshotFeatureUsage.md @@ -0,0 +1,82 @@ +# CloudProviderAccessExportSnapshotFeatureUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FeatureId** | Pointer to [**CloudProviderAccessFeatureUsageExportSnapshotFeatureId**](CloudProviderAccessFeatureUsageExportSnapshotFeatureId.md) | | [optional] +**FeatureType** | Pointer to **string** | Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. | [optional] [readonly] + +## Methods + +### NewCloudProviderAccessExportSnapshotFeatureUsage + +`func NewCloudProviderAccessExportSnapshotFeatureUsage() *CloudProviderAccessExportSnapshotFeatureUsage` + +NewCloudProviderAccessExportSnapshotFeatureUsage instantiates a new CloudProviderAccessExportSnapshotFeatureUsage object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessExportSnapshotFeatureUsageWithDefaults + +`func NewCloudProviderAccessExportSnapshotFeatureUsageWithDefaults() *CloudProviderAccessExportSnapshotFeatureUsage` + +NewCloudProviderAccessExportSnapshotFeatureUsageWithDefaults instantiates a new CloudProviderAccessExportSnapshotFeatureUsage object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFeatureId + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) GetFeatureId() CloudProviderAccessFeatureUsageExportSnapshotFeatureId` + +GetFeatureId returns the FeatureId field if non-nil, zero value otherwise. + +### GetFeatureIdOk + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) GetFeatureIdOk() (*CloudProviderAccessFeatureUsageExportSnapshotFeatureId, bool)` + +GetFeatureIdOk returns a tuple with the FeatureId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureId + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) SetFeatureId(v CloudProviderAccessFeatureUsageExportSnapshotFeatureId)` + +SetFeatureId sets FeatureId field to given value. + +### HasFeatureId + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) HasFeatureId() bool` + +HasFeatureId returns a boolean if a field has been set. + +### GetFeatureType + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) GetFeatureType() string` + +GetFeatureType returns the FeatureType field if non-nil, zero value otherwise. + +### GetFeatureTypeOk + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) GetFeatureTypeOk() (*string, bool)` + +GetFeatureTypeOk returns a tuple with the FeatureType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureType + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) SetFeatureType(v string)` + +SetFeatureType sets FeatureType field to given value. + +### HasFeatureType + +`func (o *CloudProviderAccessExportSnapshotFeatureUsage) HasFeatureType() bool` + +HasFeatureType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessFeatureUsage.md b/docs/docs/CloudProviderAccessFeatureUsage.md new file mode 100644 index 00000000..83587645 --- /dev/null +++ b/docs/docs/CloudProviderAccessFeatureUsage.md @@ -0,0 +1,82 @@ +# CloudProviderAccessFeatureUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FeatureId** | Pointer to [**CloudProviderAccessFeatureUsageExportSnapshotFeatureId**](CloudProviderAccessFeatureUsageExportSnapshotFeatureId.md) | | [optional] +**FeatureType** | Pointer to **string** | Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role. | [optional] [readonly] + +## Methods + +### NewCloudProviderAccessFeatureUsage + +`func NewCloudProviderAccessFeatureUsage() *CloudProviderAccessFeatureUsage` + +NewCloudProviderAccessFeatureUsage instantiates a new CloudProviderAccessFeatureUsage object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessFeatureUsageWithDefaults + +`func NewCloudProviderAccessFeatureUsageWithDefaults() *CloudProviderAccessFeatureUsage` + +NewCloudProviderAccessFeatureUsageWithDefaults instantiates a new CloudProviderAccessFeatureUsage object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFeatureId + +`func (o *CloudProviderAccessFeatureUsage) GetFeatureId() CloudProviderAccessFeatureUsageExportSnapshotFeatureId` + +GetFeatureId returns the FeatureId field if non-nil, zero value otherwise. + +### GetFeatureIdOk + +`func (o *CloudProviderAccessFeatureUsage) GetFeatureIdOk() (*CloudProviderAccessFeatureUsageExportSnapshotFeatureId, bool)` + +GetFeatureIdOk returns a tuple with the FeatureId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureId + +`func (o *CloudProviderAccessFeatureUsage) SetFeatureId(v CloudProviderAccessFeatureUsageExportSnapshotFeatureId)` + +SetFeatureId sets FeatureId field to given value. + +### HasFeatureId + +`func (o *CloudProviderAccessFeatureUsage) HasFeatureId() bool` + +HasFeatureId returns a boolean if a field has been set. + +### GetFeatureType + +`func (o *CloudProviderAccessFeatureUsage) GetFeatureType() string` + +GetFeatureType returns the FeatureType field if non-nil, zero value otherwise. + +### GetFeatureTypeOk + +`func (o *CloudProviderAccessFeatureUsage) GetFeatureTypeOk() (*string, bool)` + +GetFeatureTypeOk returns a tuple with the FeatureType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureType + +`func (o *CloudProviderAccessFeatureUsage) SetFeatureType(v string)` + +SetFeatureType sets FeatureType field to given value. + +### HasFeatureType + +`func (o *CloudProviderAccessFeatureUsage) HasFeatureType() bool` + +HasFeatureType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessFeatureUsageDataLakeFeatureId.md b/docs/docs/CloudProviderAccessFeatureUsageDataLakeFeatureId.md new file mode 100644 index 00000000..da993049 --- /dev/null +++ b/docs/docs/CloudProviderAccessFeatureUsageDataLakeFeatureId.md @@ -0,0 +1,82 @@ +# CloudProviderAccessFeatureUsageDataLakeFeatureId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies your project. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the data lake. | [optional] + +## Methods + +### NewCloudProviderAccessFeatureUsageDataLakeFeatureId + +`func NewCloudProviderAccessFeatureUsageDataLakeFeatureId() *CloudProviderAccessFeatureUsageDataLakeFeatureId` + +NewCloudProviderAccessFeatureUsageDataLakeFeatureId instantiates a new CloudProviderAccessFeatureUsageDataLakeFeatureId object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessFeatureUsageDataLakeFeatureIdWithDefaults + +`func NewCloudProviderAccessFeatureUsageDataLakeFeatureIdWithDefaults() *CloudProviderAccessFeatureUsageDataLakeFeatureId` + +NewCloudProviderAccessFeatureUsageDataLakeFeatureIdWithDefaults instantiates a new CloudProviderAccessFeatureUsageDataLakeFeatureId object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetGroupId + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetName + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CloudProviderAccessFeatureUsageDataLakeFeatureId) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessFeatureUsageExportSnapshotFeatureId.md b/docs/docs/CloudProviderAccessFeatureUsageExportSnapshotFeatureId.md new file mode 100644 index 00000000..1ea5b42a --- /dev/null +++ b/docs/docs/CloudProviderAccessFeatureUsageExportSnapshotFeatureId.md @@ -0,0 +1,82 @@ +# CloudProviderAccessFeatureUsageExportSnapshotFeatureId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExportBucketId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies your project. | [optional] [readonly] + +## Methods + +### NewCloudProviderAccessFeatureUsageExportSnapshotFeatureId + +`func NewCloudProviderAccessFeatureUsageExportSnapshotFeatureId() *CloudProviderAccessFeatureUsageExportSnapshotFeatureId` + +NewCloudProviderAccessFeatureUsageExportSnapshotFeatureId instantiates a new CloudProviderAccessFeatureUsageExportSnapshotFeatureId object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessFeatureUsageExportSnapshotFeatureIdWithDefaults + +`func NewCloudProviderAccessFeatureUsageExportSnapshotFeatureIdWithDefaults() *CloudProviderAccessFeatureUsageExportSnapshotFeatureId` + +NewCloudProviderAccessFeatureUsageExportSnapshotFeatureIdWithDefaults instantiates a new CloudProviderAccessFeatureUsageExportSnapshotFeatureId object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetExportBucketId + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) GetExportBucketId() string` + +GetExportBucketId returns the ExportBucketId field if non-nil, zero value otherwise. + +### GetExportBucketIdOk + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) GetExportBucketIdOk() (*string, bool)` + +GetExportBucketIdOk returns a tuple with the ExportBucketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportBucketId + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) SetExportBucketId(v string)` + +SetExportBucketId sets ExportBucketId field to given value. + +### HasExportBucketId + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) HasExportBucketId() bool` + +HasExportBucketId returns a boolean if a field has been set. + +### GetGroupId + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *CloudProviderAccessFeatureUsageExportSnapshotFeatureId) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderAccessRole.md b/docs/docs/CloudProviderAccessRole.md new file mode 100644 index 00000000..64f537c0 --- /dev/null +++ b/docs/docs/CloudProviderAccessRole.md @@ -0,0 +1,363 @@ +# CloudProviderAccessRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AtlasAWSAccountArn** | Pointer to **string** | Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role. | [optional] [readonly] +**AtlasAssumedRoleExternalId** | Pointer to **string** | Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account. | [optional] [readonly] +**AuthorizedDate** | Pointer to **time.Time** | Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**CreatedDate** | Pointer to **time.Time** | Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FeatureUsages** | Pointer to [**[]CloudProviderAccessFeatureUsage**](CloudProviderAccessFeatureUsage.md) | List that contains application features associated with this Azure Service Principal. | [optional] [readonly] +**IamAssumedRoleArn** | Pointer to **string** | Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account. | [optional] +**RoleId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the role. | [optional] [readonly] +**ProviderName** | **string** | Human-readable label that identifies the cloud provider of the role. | +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas. | [optional] [readonly] +**AtlasAzureAppId** | Pointer to **string** | Azure Active Directory Application ID of Atlas. | [optional] +**LastUpdatedDate** | Pointer to **time.Time** | Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**ServicePrincipalId** | Pointer to **string** | UUID string that identifies the Azure Service Principal. | [optional] +**TenantId** | Pointer to **string** | UUID String that identifies the Azure Active Directory Tenant ID. | [optional] + +## Methods + +### NewCloudProviderAccessRole + +`func NewCloudProviderAccessRole(providerName string, ) *CloudProviderAccessRole` + +NewCloudProviderAccessRole instantiates a new CloudProviderAccessRole object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderAccessRoleWithDefaults + +`func NewCloudProviderAccessRoleWithDefaults() *CloudProviderAccessRole` + +NewCloudProviderAccessRoleWithDefaults instantiates a new CloudProviderAccessRole object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAtlasAWSAccountArn + +`func (o *CloudProviderAccessRole) GetAtlasAWSAccountArn() string` + +GetAtlasAWSAccountArn returns the AtlasAWSAccountArn field if non-nil, zero value otherwise. + +### GetAtlasAWSAccountArnOk + +`func (o *CloudProviderAccessRole) GetAtlasAWSAccountArnOk() (*string, bool)` + +GetAtlasAWSAccountArnOk returns a tuple with the AtlasAWSAccountArn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasAWSAccountArn + +`func (o *CloudProviderAccessRole) SetAtlasAWSAccountArn(v string)` + +SetAtlasAWSAccountArn sets AtlasAWSAccountArn field to given value. + +### HasAtlasAWSAccountArn + +`func (o *CloudProviderAccessRole) HasAtlasAWSAccountArn() bool` + +HasAtlasAWSAccountArn returns a boolean if a field has been set. + +### GetAtlasAssumedRoleExternalId + +`func (o *CloudProviderAccessRole) GetAtlasAssumedRoleExternalId() string` + +GetAtlasAssumedRoleExternalId returns the AtlasAssumedRoleExternalId field if non-nil, zero value otherwise. + +### GetAtlasAssumedRoleExternalIdOk + +`func (o *CloudProviderAccessRole) GetAtlasAssumedRoleExternalIdOk() (*string, bool)` + +GetAtlasAssumedRoleExternalIdOk returns a tuple with the AtlasAssumedRoleExternalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasAssumedRoleExternalId + +`func (o *CloudProviderAccessRole) SetAtlasAssumedRoleExternalId(v string)` + +SetAtlasAssumedRoleExternalId sets AtlasAssumedRoleExternalId field to given value. + +### HasAtlasAssumedRoleExternalId + +`func (o *CloudProviderAccessRole) HasAtlasAssumedRoleExternalId() bool` + +HasAtlasAssumedRoleExternalId returns a boolean if a field has been set. + +### GetAuthorizedDate + +`func (o *CloudProviderAccessRole) GetAuthorizedDate() time.Time` + +GetAuthorizedDate returns the AuthorizedDate field if non-nil, zero value otherwise. + +### GetAuthorizedDateOk + +`func (o *CloudProviderAccessRole) GetAuthorizedDateOk() (*time.Time, bool)` + +GetAuthorizedDateOk returns a tuple with the AuthorizedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizedDate + +`func (o *CloudProviderAccessRole) SetAuthorizedDate(v time.Time)` + +SetAuthorizedDate sets AuthorizedDate field to given value. + +### HasAuthorizedDate + +`func (o *CloudProviderAccessRole) HasAuthorizedDate() bool` + +HasAuthorizedDate returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *CloudProviderAccessRole) GetCreatedDate() time.Time` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *CloudProviderAccessRole) GetCreatedDateOk() (*time.Time, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *CloudProviderAccessRole) SetCreatedDate(v time.Time)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *CloudProviderAccessRole) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetFeatureUsages + +`func (o *CloudProviderAccessRole) GetFeatureUsages() []CloudProviderAccessFeatureUsage` + +GetFeatureUsages returns the FeatureUsages field if non-nil, zero value otherwise. + +### GetFeatureUsagesOk + +`func (o *CloudProviderAccessRole) GetFeatureUsagesOk() (*[]CloudProviderAccessFeatureUsage, bool)` + +GetFeatureUsagesOk returns a tuple with the FeatureUsages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureUsages + +`func (o *CloudProviderAccessRole) SetFeatureUsages(v []CloudProviderAccessFeatureUsage)` + +SetFeatureUsages sets FeatureUsages field to given value. + +### HasFeatureUsages + +`func (o *CloudProviderAccessRole) HasFeatureUsages() bool` + +HasFeatureUsages returns a boolean if a field has been set. + +### GetIamAssumedRoleArn + +`func (o *CloudProviderAccessRole) GetIamAssumedRoleArn() string` + +GetIamAssumedRoleArn returns the IamAssumedRoleArn field if non-nil, zero value otherwise. + +### GetIamAssumedRoleArnOk + +`func (o *CloudProviderAccessRole) GetIamAssumedRoleArnOk() (*string, bool)` + +GetIamAssumedRoleArnOk returns a tuple with the IamAssumedRoleArn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIamAssumedRoleArn + +`func (o *CloudProviderAccessRole) SetIamAssumedRoleArn(v string)` + +SetIamAssumedRoleArn sets IamAssumedRoleArn field to given value. + +### HasIamAssumedRoleArn + +`func (o *CloudProviderAccessRole) HasIamAssumedRoleArn() bool` + +HasIamAssumedRoleArn returns a boolean if a field has been set. + +### GetRoleId + +`func (o *CloudProviderAccessRole) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *CloudProviderAccessRole) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *CloudProviderAccessRole) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *CloudProviderAccessRole) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *CloudProviderAccessRole) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *CloudProviderAccessRole) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *CloudProviderAccessRole) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetId + +`func (o *CloudProviderAccessRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CloudProviderAccessRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CloudProviderAccessRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CloudProviderAccessRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAtlasAzureAppId + +`func (o *CloudProviderAccessRole) GetAtlasAzureAppId() string` + +GetAtlasAzureAppId returns the AtlasAzureAppId field if non-nil, zero value otherwise. + +### GetAtlasAzureAppIdOk + +`func (o *CloudProviderAccessRole) GetAtlasAzureAppIdOk() (*string, bool)` + +GetAtlasAzureAppIdOk returns a tuple with the AtlasAzureAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasAzureAppId + +`func (o *CloudProviderAccessRole) SetAtlasAzureAppId(v string)` + +SetAtlasAzureAppId sets AtlasAzureAppId field to given value. + +### HasAtlasAzureAppId + +`func (o *CloudProviderAccessRole) HasAtlasAzureAppId() bool` + +HasAtlasAzureAppId returns a boolean if a field has been set. + +### GetLastUpdatedDate + +`func (o *CloudProviderAccessRole) GetLastUpdatedDate() time.Time` + +GetLastUpdatedDate returns the LastUpdatedDate field if non-nil, zero value otherwise. + +### GetLastUpdatedDateOk + +`func (o *CloudProviderAccessRole) GetLastUpdatedDateOk() (*time.Time, bool)` + +GetLastUpdatedDateOk returns a tuple with the LastUpdatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdatedDate + +`func (o *CloudProviderAccessRole) SetLastUpdatedDate(v time.Time)` + +SetLastUpdatedDate sets LastUpdatedDate field to given value. + +### HasLastUpdatedDate + +`func (o *CloudProviderAccessRole) HasLastUpdatedDate() bool` + +HasLastUpdatedDate returns a boolean if a field has been set. + +### GetServicePrincipalId + +`func (o *CloudProviderAccessRole) GetServicePrincipalId() string` + +GetServicePrincipalId returns the ServicePrincipalId field if non-nil, zero value otherwise. + +### GetServicePrincipalIdOk + +`func (o *CloudProviderAccessRole) GetServicePrincipalIdOk() (*string, bool)` + +GetServicePrincipalIdOk returns a tuple with the ServicePrincipalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServicePrincipalId + +`func (o *CloudProviderAccessRole) SetServicePrincipalId(v string)` + +SetServicePrincipalId sets ServicePrincipalId field to given value. + +### HasServicePrincipalId + +`func (o *CloudProviderAccessRole) HasServicePrincipalId() bool` + +HasServicePrincipalId returns a boolean if a field has been set. + +### GetTenantId + +`func (o *CloudProviderAccessRole) GetTenantId() string` + +GetTenantId returns the TenantId field if non-nil, zero value otherwise. + +### GetTenantIdOk + +`func (o *CloudProviderAccessRole) GetTenantIdOk() (*string, bool)` + +GetTenantIdOk returns a tuple with the TenantId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantId + +`func (o *CloudProviderAccessRole) SetTenantId(v string)` + +SetTenantId sets TenantId field to given value. + +### HasTenantId + +`func (o *CloudProviderAccessRole) HasTenantId() bool` + +HasTenantId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CloudProviderContainer.md b/docs/docs/CloudProviderContainer.md new file mode 100644 index 00000000..d9718a05 --- /dev/null +++ b/docs/docs/CloudProviderContainer.md @@ -0,0 +1,327 @@ +# CloudProviderContainer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AtlasCidrBlock** | **string** | IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. | +**AzureSubscriptionId** | Pointer to **string** | Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides. | [optional] [readonly] +**Region** | **string** | Azure region to which MongoDB Cloud deployed this network peering container. | +**VnetName** | Pointer to **string** | Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering container. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering containers. | [optional] +**Provisioned** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. | [optional] [readonly] +**GcpProjectId** | Pointer to **string** | Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container. | [optional] [readonly] +**NetworkName** | Pointer to **string** | Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container. | [optional] [readonly] +**Regions** | Pointer to **[]string** | List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects. | [optional] +**RegionName** | **string** | Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. | +**VpcId** | Pointer to **string** | Unique string that identifies the MongoDB Cloud VPC on AWS. | [optional] [readonly] + +## Methods + +### NewCloudProviderContainer + +`func NewCloudProviderContainer(atlasCidrBlock string, region string, regionName string, ) *CloudProviderContainer` + +NewCloudProviderContainer instantiates a new CloudProviderContainer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCloudProviderContainerWithDefaults + +`func NewCloudProviderContainerWithDefaults() *CloudProviderContainer` + +NewCloudProviderContainerWithDefaults instantiates a new CloudProviderContainer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAtlasCidrBlock + +`func (o *CloudProviderContainer) GetAtlasCidrBlock() string` + +GetAtlasCidrBlock returns the AtlasCidrBlock field if non-nil, zero value otherwise. + +### GetAtlasCidrBlockOk + +`func (o *CloudProviderContainer) GetAtlasCidrBlockOk() (*string, bool)` + +GetAtlasCidrBlockOk returns a tuple with the AtlasCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasCidrBlock + +`func (o *CloudProviderContainer) SetAtlasCidrBlock(v string)` + +SetAtlasCidrBlock sets AtlasCidrBlock field to given value. + + +### GetAzureSubscriptionId + +`func (o *CloudProviderContainer) GetAzureSubscriptionId() string` + +GetAzureSubscriptionId returns the AzureSubscriptionId field if non-nil, zero value otherwise. + +### GetAzureSubscriptionIdOk + +`func (o *CloudProviderContainer) GetAzureSubscriptionIdOk() (*string, bool)` + +GetAzureSubscriptionIdOk returns a tuple with the AzureSubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureSubscriptionId + +`func (o *CloudProviderContainer) SetAzureSubscriptionId(v string)` + +SetAzureSubscriptionId sets AzureSubscriptionId field to given value. + +### HasAzureSubscriptionId + +`func (o *CloudProviderContainer) HasAzureSubscriptionId() bool` + +HasAzureSubscriptionId returns a boolean if a field has been set. + +### GetRegion + +`func (o *CloudProviderContainer) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *CloudProviderContainer) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *CloudProviderContainer) SetRegion(v string)` + +SetRegion sets Region field to given value. + + +### GetVnetName + +`func (o *CloudProviderContainer) GetVnetName() string` + +GetVnetName returns the VnetName field if non-nil, zero value otherwise. + +### GetVnetNameOk + +`func (o *CloudProviderContainer) GetVnetNameOk() (*string, bool)` + +GetVnetNameOk returns a tuple with the VnetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVnetName + +`func (o *CloudProviderContainer) SetVnetName(v string)` + +SetVnetName sets VnetName field to given value. + +### HasVnetName + +`func (o *CloudProviderContainer) HasVnetName() bool` + +HasVnetName returns a boolean if a field has been set. + +### GetId + +`func (o *CloudProviderContainer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CloudProviderContainer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CloudProviderContainer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CloudProviderContainer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *CloudProviderContainer) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *CloudProviderContainer) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *CloudProviderContainer) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *CloudProviderContainer) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetProvisioned + +`func (o *CloudProviderContainer) GetProvisioned() bool` + +GetProvisioned returns the Provisioned field if non-nil, zero value otherwise. + +### GetProvisionedOk + +`func (o *CloudProviderContainer) GetProvisionedOk() (*bool, bool)` + +GetProvisionedOk returns a tuple with the Provisioned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioned + +`func (o *CloudProviderContainer) SetProvisioned(v bool)` + +SetProvisioned sets Provisioned field to given value. + +### HasProvisioned + +`func (o *CloudProviderContainer) HasProvisioned() bool` + +HasProvisioned returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *CloudProviderContainer) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *CloudProviderContainer) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *CloudProviderContainer) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + +### HasGcpProjectId + +`func (o *CloudProviderContainer) HasGcpProjectId() bool` + +HasGcpProjectId returns a boolean if a field has been set. + +### GetNetworkName + +`func (o *CloudProviderContainer) GetNetworkName() string` + +GetNetworkName returns the NetworkName field if non-nil, zero value otherwise. + +### GetNetworkNameOk + +`func (o *CloudProviderContainer) GetNetworkNameOk() (*string, bool)` + +GetNetworkNameOk returns a tuple with the NetworkName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkName + +`func (o *CloudProviderContainer) SetNetworkName(v string)` + +SetNetworkName sets NetworkName field to given value. + +### HasNetworkName + +`func (o *CloudProviderContainer) HasNetworkName() bool` + +HasNetworkName returns a boolean if a field has been set. + +### GetRegions + +`func (o *CloudProviderContainer) GetRegions() []string` + +GetRegions returns the Regions field if non-nil, zero value otherwise. + +### GetRegionsOk + +`func (o *CloudProviderContainer) GetRegionsOk() (*[]string, bool)` + +GetRegionsOk returns a tuple with the Regions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegions + +`func (o *CloudProviderContainer) SetRegions(v []string)` + +SetRegions sets Regions field to given value. + +### HasRegions + +`func (o *CloudProviderContainer) HasRegions() bool` + +HasRegions returns a boolean if a field has been set. + +### GetRegionName + +`func (o *CloudProviderContainer) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *CloudProviderContainer) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *CloudProviderContainer) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + + +### GetVpcId + +`func (o *CloudProviderContainer) GetVpcId() string` + +GetVpcId returns the VpcId field if non-nil, zero value otherwise. + +### GetVpcIdOk + +`func (o *CloudProviderContainer) GetVpcIdOk() (*string, bool)` + +GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVpcId + +`func (o *CloudProviderContainer) SetVpcId(v string)` + +SetVpcId sets VpcId field to given value. + +### HasVpcId + +`func (o *CloudProviderContainer) HasVpcId() bool` + +HasVpcId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Cluster.md b/docs/docs/Cluster.md new file mode 100644 index 00000000..a6114444 --- /dev/null +++ b/docs/docs/Cluster.md @@ -0,0 +1,316 @@ +# Cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlertCount** | Pointer to **int** | Whole number that indicates the quantity of alerts open on the cluster. | [optional] [readonly] +**AuthEnabled** | Pointer to **bool** | Flag that indicates whether authentication is required to access the nodes in this cluster. | [optional] [readonly] +**Availability** | Pointer to **string** | Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated. | [optional] [readonly] +**BackupEnabled** | Pointer to **bool** | Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. | [optional] [readonly] +**ClusterId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the cluster. | [optional] [readonly] +**DataSizeBytes** | Pointer to **int64** | Total size of the data stored on each node in the cluster. The resource expresses this value in bytes. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the cluster. | [optional] [readonly] +**NodeCount** | Pointer to **int** | Whole number that indicates the quantity of nodes that comprise the cluster. | [optional] [readonly] +**SslEnabled** | Pointer to **bool** | Flag that indicates whether TLS authentication is required to access the nodes in this cluster. | [optional] [readonly] +**Type** | Pointer to **string** | Human-readable label that indicates the cluster type. | [optional] [readonly] +**Versions** | Pointer to **[]string** | List that contains the versions of MongoDB that each node in the cluster runs. | [optional] [readonly] + +## Methods + +### NewCluster + +`func NewCluster() *Cluster` + +NewCluster instantiates a new Cluster object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterWithDefaults + +`func NewClusterWithDefaults() *Cluster` + +NewClusterWithDefaults instantiates a new Cluster object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAlertCount + +`func (o *Cluster) GetAlertCount() int` + +GetAlertCount returns the AlertCount field if non-nil, zero value otherwise. + +### GetAlertCountOk + +`func (o *Cluster) GetAlertCountOk() (*int, bool)` + +GetAlertCountOk returns a tuple with the AlertCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertCount + +`func (o *Cluster) SetAlertCount(v int)` + +SetAlertCount sets AlertCount field to given value. + +### HasAlertCount + +`func (o *Cluster) HasAlertCount() bool` + +HasAlertCount returns a boolean if a field has been set. + +### GetAuthEnabled + +`func (o *Cluster) GetAuthEnabled() bool` + +GetAuthEnabled returns the AuthEnabled field if non-nil, zero value otherwise. + +### GetAuthEnabledOk + +`func (o *Cluster) GetAuthEnabledOk() (*bool, bool)` + +GetAuthEnabledOk returns a tuple with the AuthEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthEnabled + +`func (o *Cluster) SetAuthEnabled(v bool)` + +SetAuthEnabled sets AuthEnabled field to given value. + +### HasAuthEnabled + +`func (o *Cluster) HasAuthEnabled() bool` + +HasAuthEnabled returns a boolean if a field has been set. + +### GetAvailability + +`func (o *Cluster) GetAvailability() string` + +GetAvailability returns the Availability field if non-nil, zero value otherwise. + +### GetAvailabilityOk + +`func (o *Cluster) GetAvailabilityOk() (*string, bool)` + +GetAvailabilityOk returns a tuple with the Availability field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvailability + +`func (o *Cluster) SetAvailability(v string)` + +SetAvailability sets Availability field to given value. + +### HasAvailability + +`func (o *Cluster) HasAvailability() bool` + +HasAvailability returns a boolean if a field has been set. + +### GetBackupEnabled + +`func (o *Cluster) GetBackupEnabled() bool` + +GetBackupEnabled returns the BackupEnabled field if non-nil, zero value otherwise. + +### GetBackupEnabledOk + +`func (o *Cluster) GetBackupEnabledOk() (*bool, bool)` + +GetBackupEnabledOk returns a tuple with the BackupEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupEnabled + +`func (o *Cluster) SetBackupEnabled(v bool)` + +SetBackupEnabled sets BackupEnabled field to given value. + +### HasBackupEnabled + +`func (o *Cluster) HasBackupEnabled() bool` + +HasBackupEnabled returns a boolean if a field has been set. + +### GetClusterId + +`func (o *Cluster) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *Cluster) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *Cluster) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + +### HasClusterId + +`func (o *Cluster) HasClusterId() bool` + +HasClusterId returns a boolean if a field has been set. + +### GetDataSizeBytes + +`func (o *Cluster) GetDataSizeBytes() int64` + +GetDataSizeBytes returns the DataSizeBytes field if non-nil, zero value otherwise. + +### GetDataSizeBytesOk + +`func (o *Cluster) GetDataSizeBytesOk() (*int64, bool)` + +GetDataSizeBytesOk returns a tuple with the DataSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSizeBytes + +`func (o *Cluster) SetDataSizeBytes(v int64)` + +SetDataSizeBytes sets DataSizeBytes field to given value. + +### HasDataSizeBytes + +`func (o *Cluster) HasDataSizeBytes() bool` + +HasDataSizeBytes returns a boolean if a field has been set. + +### GetName + +`func (o *Cluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Cluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Cluster) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Cluster) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetNodeCount + +`func (o *Cluster) GetNodeCount() int` + +GetNodeCount returns the NodeCount field if non-nil, zero value otherwise. + +### GetNodeCountOk + +`func (o *Cluster) GetNodeCountOk() (*int, bool)` + +GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNodeCount + +`func (o *Cluster) SetNodeCount(v int)` + +SetNodeCount sets NodeCount field to given value. + +### HasNodeCount + +`func (o *Cluster) HasNodeCount() bool` + +HasNodeCount returns a boolean if a field has been set. + +### GetSslEnabled + +`func (o *Cluster) GetSslEnabled() bool` + +GetSslEnabled returns the SslEnabled field if non-nil, zero value otherwise. + +### GetSslEnabledOk + +`func (o *Cluster) GetSslEnabledOk() (*bool, bool)` + +GetSslEnabledOk returns a tuple with the SslEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSslEnabled + +`func (o *Cluster) SetSslEnabled(v bool)` + +SetSslEnabled sets SslEnabled field to given value. + +### HasSslEnabled + +`func (o *Cluster) HasSslEnabled() bool` + +HasSslEnabled returns a boolean if a field has been set. + +### GetType + +`func (o *Cluster) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Cluster) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Cluster) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Cluster) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetVersions + +`func (o *Cluster) GetVersions() []string` + +GetVersions returns the Versions field if non-nil, zero value otherwise. + +### GetVersionsOk + +`func (o *Cluster) GetVersionsOk() (*[]string, bool)` + +GetVersionsOk returns a tuple with the Versions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersions + +`func (o *Cluster) SetVersions(v []string)` + +SetVersions sets Versions field to given value. + +### HasVersions + +`func (o *Cluster) HasVersions() bool` + +HasVersions returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterAlert.md b/docs/docs/ClusterAlert.md new file mode 100644 index 00000000..c6baa64e --- /dev/null +++ b/docs/docs/ClusterAlert.md @@ -0,0 +1,385 @@ +# ClusterAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**ClusterEventTypeViewAlertable**](ClusterEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewClusterAlert + +`func NewClusterAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName ClusterEventTypeViewAlertable, id string, status string, updated time.Time, ) *ClusterAlert` + +NewClusterAlert instantiates a new ClusterAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterAlertWithDefaults + +`func NewClusterAlertWithDefaults() *ClusterAlert` + +NewClusterAlertWithDefaults instantiates a new ClusterAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *ClusterAlert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *ClusterAlert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *ClusterAlert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *ClusterAlert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *ClusterAlert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *ClusterAlert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *ClusterAlert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *ClusterAlert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *ClusterAlert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *ClusterAlert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *ClusterAlert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *ClusterAlert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *ClusterAlert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *ClusterAlert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *ClusterAlert) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *ClusterAlert) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *ClusterAlert) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *ClusterAlert) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *ClusterAlert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ClusterAlert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ClusterAlert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *ClusterAlert) GetEventTypeName() ClusterEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ClusterAlert) GetEventTypeNameOk() (*ClusterEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ClusterAlert) SetEventTypeName(v ClusterEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ClusterAlert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ClusterAlert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ClusterAlert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ClusterAlert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ClusterAlert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ClusterAlert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ClusterAlert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *ClusterAlert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *ClusterAlert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *ClusterAlert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *ClusterAlert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *ClusterAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ClusterAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ClusterAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ClusterAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *ClusterAlert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ClusterAlert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ClusterAlert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *ClusterAlert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetResolved + +`func (o *ClusterAlert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *ClusterAlert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *ClusterAlert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *ClusterAlert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *ClusterAlert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ClusterAlert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ClusterAlert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *ClusterAlert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *ClusterAlert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *ClusterAlert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterAlertConfigViewForNdsGroup.md b/docs/docs/ClusterAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..a2082c51 --- /dev/null +++ b/docs/docs/ClusterAlertConfigViewForNdsGroup.md @@ -0,0 +1,259 @@ +# ClusterAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**ClusterEventTypeViewAlertable**](ClusterEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]ClusterMatcher**](ClusterMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewClusterAlertConfigViewForNdsGroup + +`func NewClusterAlertConfigViewForNdsGroup(eventTypeName ClusterEventTypeViewAlertable, ) *ClusterAlertConfigViewForNdsGroup` + +NewClusterAlertConfigViewForNdsGroup instantiates a new ClusterAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterAlertConfigViewForNdsGroupWithDefaults + +`func NewClusterAlertConfigViewForNdsGroupWithDefaults() *ClusterAlertConfigViewForNdsGroup` + +NewClusterAlertConfigViewForNdsGroupWithDefaults instantiates a new ClusterAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *ClusterAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ClusterAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ClusterAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *ClusterAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ClusterAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ClusterAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *ClusterAlertConfigViewForNdsGroup) GetEventTypeName() ClusterEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*ClusterEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ClusterAlertConfigViewForNdsGroup) SetEventTypeName(v ClusterEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ClusterAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ClusterAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ClusterAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ClusterAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ClusterAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ClusterAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ClusterAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ClusterAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ClusterAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *ClusterAlertConfigViewForNdsGroup) GetMatchers() []ClusterMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetMatchersOk() (*[]ClusterMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *ClusterAlertConfigViewForNdsGroup) SetMatchers(v []ClusterMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *ClusterAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *ClusterAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *ClusterAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *ClusterAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *ClusterAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *ClusterAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *ClusterAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *ClusterAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterDescriptionConnectionStrings.md b/docs/docs/ClusterDescriptionConnectionStrings.md new file mode 100644 index 00000000..db44b2f0 --- /dev/null +++ b/docs/docs/ClusterDescriptionConnectionStrings.md @@ -0,0 +1,212 @@ +# ClusterDescriptionConnectionStrings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsPrivateLink** | Pointer to **map[string]string** | Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names. | [optional] [readonly] +**AwsPrivateLinkSrv** | Pointer to **map[string]string** | Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. | [optional] [readonly] +**Private** | Pointer to **string** | Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS. | [optional] [readonly] +**PrivateEndpoint** | Pointer to [**[]ClusterDescriptionConnectionStringsPrivateEndpoint**](ClusterDescriptionConnectionStringsPrivateEndpoint.md) | List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes. | [optional] [readonly] +**PrivateSrv** | Pointer to **string** | Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/). | [optional] [readonly] +**Standard** | Pointer to **string** | Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol. | [optional] [readonly] +**StandardSrv** | Pointer to **string** | Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. | [optional] [readonly] + +## Methods + +### NewClusterDescriptionConnectionStrings + +`func NewClusterDescriptionConnectionStrings() *ClusterDescriptionConnectionStrings` + +NewClusterDescriptionConnectionStrings instantiates a new ClusterDescriptionConnectionStrings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterDescriptionConnectionStringsWithDefaults + +`func NewClusterDescriptionConnectionStringsWithDefaults() *ClusterDescriptionConnectionStrings` + +NewClusterDescriptionConnectionStringsWithDefaults instantiates a new ClusterDescriptionConnectionStrings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAwsPrivateLink + +`func (o *ClusterDescriptionConnectionStrings) GetAwsPrivateLink() map[string]string` + +GetAwsPrivateLink returns the AwsPrivateLink field if non-nil, zero value otherwise. + +### GetAwsPrivateLinkOk + +`func (o *ClusterDescriptionConnectionStrings) GetAwsPrivateLinkOk() (*map[string]string, bool)` + +GetAwsPrivateLinkOk returns a tuple with the AwsPrivateLink field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsPrivateLink + +`func (o *ClusterDescriptionConnectionStrings) SetAwsPrivateLink(v map[string]string)` + +SetAwsPrivateLink sets AwsPrivateLink field to given value. + +### HasAwsPrivateLink + +`func (o *ClusterDescriptionConnectionStrings) HasAwsPrivateLink() bool` + +HasAwsPrivateLink returns a boolean if a field has been set. + +### GetAwsPrivateLinkSrv + +`func (o *ClusterDescriptionConnectionStrings) GetAwsPrivateLinkSrv() map[string]string` + +GetAwsPrivateLinkSrv returns the AwsPrivateLinkSrv field if non-nil, zero value otherwise. + +### GetAwsPrivateLinkSrvOk + +`func (o *ClusterDescriptionConnectionStrings) GetAwsPrivateLinkSrvOk() (*map[string]string, bool)` + +GetAwsPrivateLinkSrvOk returns a tuple with the AwsPrivateLinkSrv field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsPrivateLinkSrv + +`func (o *ClusterDescriptionConnectionStrings) SetAwsPrivateLinkSrv(v map[string]string)` + +SetAwsPrivateLinkSrv sets AwsPrivateLinkSrv field to given value. + +### HasAwsPrivateLinkSrv + +`func (o *ClusterDescriptionConnectionStrings) HasAwsPrivateLinkSrv() bool` + +HasAwsPrivateLinkSrv returns a boolean if a field has been set. + +### GetPrivate + +`func (o *ClusterDescriptionConnectionStrings) GetPrivate() string` + +GetPrivate returns the Private field if non-nil, zero value otherwise. + +### GetPrivateOk + +`func (o *ClusterDescriptionConnectionStrings) GetPrivateOk() (*string, bool)` + +GetPrivateOk returns a tuple with the Private field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivate + +`func (o *ClusterDescriptionConnectionStrings) SetPrivate(v string)` + +SetPrivate sets Private field to given value. + +### HasPrivate + +`func (o *ClusterDescriptionConnectionStrings) HasPrivate() bool` + +HasPrivate returns a boolean if a field has been set. + +### GetPrivateEndpoint + +`func (o *ClusterDescriptionConnectionStrings) GetPrivateEndpoint() []ClusterDescriptionConnectionStringsPrivateEndpoint` + +GetPrivateEndpoint returns the PrivateEndpoint field if non-nil, zero value otherwise. + +### GetPrivateEndpointOk + +`func (o *ClusterDescriptionConnectionStrings) GetPrivateEndpointOk() (*[]ClusterDescriptionConnectionStringsPrivateEndpoint, bool)` + +GetPrivateEndpointOk returns a tuple with the PrivateEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpoint + +`func (o *ClusterDescriptionConnectionStrings) SetPrivateEndpoint(v []ClusterDescriptionConnectionStringsPrivateEndpoint)` + +SetPrivateEndpoint sets PrivateEndpoint field to given value. + +### HasPrivateEndpoint + +`func (o *ClusterDescriptionConnectionStrings) HasPrivateEndpoint() bool` + +HasPrivateEndpoint returns a boolean if a field has been set. + +### GetPrivateSrv + +`func (o *ClusterDescriptionConnectionStrings) GetPrivateSrv() string` + +GetPrivateSrv returns the PrivateSrv field if non-nil, zero value otherwise. + +### GetPrivateSrvOk + +`func (o *ClusterDescriptionConnectionStrings) GetPrivateSrvOk() (*string, bool)` + +GetPrivateSrvOk returns a tuple with the PrivateSrv field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateSrv + +`func (o *ClusterDescriptionConnectionStrings) SetPrivateSrv(v string)` + +SetPrivateSrv sets PrivateSrv field to given value. + +### HasPrivateSrv + +`func (o *ClusterDescriptionConnectionStrings) HasPrivateSrv() bool` + +HasPrivateSrv returns a boolean if a field has been set. + +### GetStandard + +`func (o *ClusterDescriptionConnectionStrings) GetStandard() string` + +GetStandard returns the Standard field if non-nil, zero value otherwise. + +### GetStandardOk + +`func (o *ClusterDescriptionConnectionStrings) GetStandardOk() (*string, bool)` + +GetStandardOk returns a tuple with the Standard field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandard + +`func (o *ClusterDescriptionConnectionStrings) SetStandard(v string)` + +SetStandard sets Standard field to given value. + +### HasStandard + +`func (o *ClusterDescriptionConnectionStrings) HasStandard() bool` + +HasStandard returns a boolean if a field has been set. + +### GetStandardSrv + +`func (o *ClusterDescriptionConnectionStrings) GetStandardSrv() string` + +GetStandardSrv returns the StandardSrv field if non-nil, zero value otherwise. + +### GetStandardSrvOk + +`func (o *ClusterDescriptionConnectionStrings) GetStandardSrvOk() (*string, bool)` + +GetStandardSrvOk returns a tuple with the StandardSrv field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandardSrv + +`func (o *ClusterDescriptionConnectionStrings) SetStandardSrv(v string)` + +SetStandardSrv sets StandardSrv field to given value. + +### HasStandardSrv + +`func (o *ClusterDescriptionConnectionStrings) HasStandardSrv() bool` + +HasStandardSrv returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterDescriptionConnectionStringsPrivateEndpoint.md b/docs/docs/ClusterDescriptionConnectionStringsPrivateEndpoint.md new file mode 100644 index 00000000..6cd63fa4 --- /dev/null +++ b/docs/docs/ClusterDescriptionConnectionStringsPrivateEndpoint.md @@ -0,0 +1,160 @@ +# ClusterDescriptionConnectionStringsPrivateEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectionString** | Pointer to **string** | Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint. | [optional] [readonly] +**Endpoints** | Pointer to [**[]ClusterDescriptionConnectionStringsPrivateEndpointEndpoint**](ClusterDescriptionConnectionStringsPrivateEndpointEndpoint.md) | List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**. | [optional] [readonly] +**SrvConnectionString** | Pointer to **string** | Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString. | [optional] [readonly] +**SrvShardOptimizedConnectionString** | Pointer to **string** | Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString. | [optional] [readonly] +**Type** | Pointer to **string** | MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters. | [optional] [readonly] + +## Methods + +### NewClusterDescriptionConnectionStringsPrivateEndpoint + +`func NewClusterDescriptionConnectionStringsPrivateEndpoint() *ClusterDescriptionConnectionStringsPrivateEndpoint` + +NewClusterDescriptionConnectionStringsPrivateEndpoint instantiates a new ClusterDescriptionConnectionStringsPrivateEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterDescriptionConnectionStringsPrivateEndpointWithDefaults + +`func NewClusterDescriptionConnectionStringsPrivateEndpointWithDefaults() *ClusterDescriptionConnectionStringsPrivateEndpoint` + +NewClusterDescriptionConnectionStringsPrivateEndpointWithDefaults instantiates a new ClusterDescriptionConnectionStringsPrivateEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetConnectionString() string` + +GetConnectionString returns the ConnectionString field if non-nil, zero value otherwise. + +### GetConnectionStringOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetConnectionStringOk() (*string, bool)` + +GetConnectionStringOk returns a tuple with the ConnectionString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) SetConnectionString(v string)` + +SetConnectionString sets ConnectionString field to given value. + +### HasConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) HasConnectionString() bool` + +HasConnectionString returns a boolean if a field has been set. + +### GetEndpoints + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetEndpoints() []ClusterDescriptionConnectionStringsPrivateEndpointEndpoint` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetEndpointsOk() (*[]ClusterDescriptionConnectionStringsPrivateEndpointEndpoint, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpoints + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) SetEndpoints(v []ClusterDescriptionConnectionStringsPrivateEndpointEndpoint)` + +SetEndpoints sets Endpoints field to given value. + +### HasEndpoints + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### GetSrvConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetSrvConnectionString() string` + +GetSrvConnectionString returns the SrvConnectionString field if non-nil, zero value otherwise. + +### GetSrvConnectionStringOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetSrvConnectionStringOk() (*string, bool)` + +GetSrvConnectionStringOk returns a tuple with the SrvConnectionString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSrvConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) SetSrvConnectionString(v string)` + +SetSrvConnectionString sets SrvConnectionString field to given value. + +### HasSrvConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) HasSrvConnectionString() bool` + +HasSrvConnectionString returns a boolean if a field has been set. + +### GetSrvShardOptimizedConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetSrvShardOptimizedConnectionString() string` + +GetSrvShardOptimizedConnectionString returns the SrvShardOptimizedConnectionString field if non-nil, zero value otherwise. + +### GetSrvShardOptimizedConnectionStringOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetSrvShardOptimizedConnectionStringOk() (*string, bool)` + +GetSrvShardOptimizedConnectionStringOk returns a tuple with the SrvShardOptimizedConnectionString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSrvShardOptimizedConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) SetSrvShardOptimizedConnectionString(v string)` + +SetSrvShardOptimizedConnectionString sets SrvShardOptimizedConnectionString field to given value. + +### HasSrvShardOptimizedConnectionString + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) HasSrvShardOptimizedConnectionString() bool` + +HasSrvShardOptimizedConnectionString returns a boolean if a field has been set. + +### GetType + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpoint) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint.md b/docs/docs/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint.md new file mode 100644 index 00000000..11ae2d97 --- /dev/null +++ b/docs/docs/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint.md @@ -0,0 +1,108 @@ +# ClusterDescriptionConnectionStringsPrivateEndpointEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointId** | Pointer to **string** | Unique string that the cloud provider uses to identify the private endpoint. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud provider in which MongoDB Cloud deploys the private endpoint. | [optional] [readonly] +**Region** | Pointer to **string** | Region where the private endpoint is deployed. | [optional] [readonly] + +## Methods + +### NewClusterDescriptionConnectionStringsPrivateEndpointEndpoint + +`func NewClusterDescriptionConnectionStringsPrivateEndpointEndpoint() *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint` + +NewClusterDescriptionConnectionStringsPrivateEndpointEndpoint instantiates a new ClusterDescriptionConnectionStringsPrivateEndpointEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterDescriptionConnectionStringsPrivateEndpointEndpointWithDefaults + +`func NewClusterDescriptionConnectionStringsPrivateEndpointEndpointWithDefaults() *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint` + +NewClusterDescriptionConnectionStringsPrivateEndpointEndpointWithDefaults instantiates a new ClusterDescriptionConnectionStringsPrivateEndpointEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointId + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) GetEndpointId() string` + +GetEndpointId returns the EndpointId field if non-nil, zero value otherwise. + +### GetEndpointIdOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) GetEndpointIdOk() (*string, bool)` + +GetEndpointIdOk returns a tuple with the EndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointId + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) SetEndpointId(v string)` + +SetEndpointId sets EndpointId field to given value. + +### HasEndpointId + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) HasEndpointId() bool` + +HasEndpointId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegion + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *ClusterDescriptionConnectionStringsPrivateEndpointEndpoint) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterDescriptionProcessArgs.md b/docs/docs/ClusterDescriptionProcessArgs.md new file mode 100644 index 00000000..df5ccafe --- /dev/null +++ b/docs/docs/ClusterDescriptionProcessArgs.md @@ -0,0 +1,310 @@ +# ClusterDescriptionProcessArgs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultReadConcern** | Pointer to **string** | [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`. | [optional] [default to "available"] +**DefaultWriteConcern** | Pointer to **string** | [Default level of acknowledgment requested from MongoDB for write operations](https://docs.mongodb.com/manual/reference/write-concern/) set for this cluster. MongoDB 4.4 clusters default to `1`. MongoDB 5.0 and later clusters default to `majority`. | [optional] [default to "1"] +**FailIndexKeyTooLong** | Pointer to **bool** | Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. | [optional] [default to true] +**JavascriptEnabled** | Pointer to **bool** | Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. | [optional] [default to true] +**MinimumEnabledTlsProtocol** | Pointer to **string** | Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version. | [optional] +**NoTableScan** | Pointer to **bool** | Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results. | [optional] [default to false] +**OplogMinRetentionHours** | Pointer to **NullableFloat64** | Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates. | [optional] +**OplogSizeMB** | Pointer to **NullableInt** | Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates. | [optional] +**SampleRefreshIntervalBIConnector** | Pointer to **int** | Interval in seconds at which the mongosqld process re-samples data to create its relational schema. | [optional] [default to 0] +**SampleSizeBIConnector** | Pointer to **int** | Number of documents per database to sample when gathering schema information. | [optional] [default to 1000] + +## Methods + +### NewClusterDescriptionProcessArgs + +`func NewClusterDescriptionProcessArgs() *ClusterDescriptionProcessArgs` + +NewClusterDescriptionProcessArgs instantiates a new ClusterDescriptionProcessArgs object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterDescriptionProcessArgsWithDefaults + +`func NewClusterDescriptionProcessArgsWithDefaults() *ClusterDescriptionProcessArgs` + +NewClusterDescriptionProcessArgsWithDefaults instantiates a new ClusterDescriptionProcessArgs object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDefaultReadConcern + +`func (o *ClusterDescriptionProcessArgs) GetDefaultReadConcern() string` + +GetDefaultReadConcern returns the DefaultReadConcern field if non-nil, zero value otherwise. + +### GetDefaultReadConcernOk + +`func (o *ClusterDescriptionProcessArgs) GetDefaultReadConcernOk() (*string, bool)` + +GetDefaultReadConcernOk returns a tuple with the DefaultReadConcern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultReadConcern + +`func (o *ClusterDescriptionProcessArgs) SetDefaultReadConcern(v string)` + +SetDefaultReadConcern sets DefaultReadConcern field to given value. + +### HasDefaultReadConcern + +`func (o *ClusterDescriptionProcessArgs) HasDefaultReadConcern() bool` + +HasDefaultReadConcern returns a boolean if a field has been set. + +### GetDefaultWriteConcern + +`func (o *ClusterDescriptionProcessArgs) GetDefaultWriteConcern() string` + +GetDefaultWriteConcern returns the DefaultWriteConcern field if non-nil, zero value otherwise. + +### GetDefaultWriteConcernOk + +`func (o *ClusterDescriptionProcessArgs) GetDefaultWriteConcernOk() (*string, bool)` + +GetDefaultWriteConcernOk returns a tuple with the DefaultWriteConcern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultWriteConcern + +`func (o *ClusterDescriptionProcessArgs) SetDefaultWriteConcern(v string)` + +SetDefaultWriteConcern sets DefaultWriteConcern field to given value. + +### HasDefaultWriteConcern + +`func (o *ClusterDescriptionProcessArgs) HasDefaultWriteConcern() bool` + +HasDefaultWriteConcern returns a boolean if a field has been set. + +### GetFailIndexKeyTooLong + +`func (o *ClusterDescriptionProcessArgs) GetFailIndexKeyTooLong() bool` + +GetFailIndexKeyTooLong returns the FailIndexKeyTooLong field if non-nil, zero value otherwise. + +### GetFailIndexKeyTooLongOk + +`func (o *ClusterDescriptionProcessArgs) GetFailIndexKeyTooLongOk() (*bool, bool)` + +GetFailIndexKeyTooLongOk returns a tuple with the FailIndexKeyTooLong field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailIndexKeyTooLong + +`func (o *ClusterDescriptionProcessArgs) SetFailIndexKeyTooLong(v bool)` + +SetFailIndexKeyTooLong sets FailIndexKeyTooLong field to given value. + +### HasFailIndexKeyTooLong + +`func (o *ClusterDescriptionProcessArgs) HasFailIndexKeyTooLong() bool` + +HasFailIndexKeyTooLong returns a boolean if a field has been set. + +### GetJavascriptEnabled + +`func (o *ClusterDescriptionProcessArgs) GetJavascriptEnabled() bool` + +GetJavascriptEnabled returns the JavascriptEnabled field if non-nil, zero value otherwise. + +### GetJavascriptEnabledOk + +`func (o *ClusterDescriptionProcessArgs) GetJavascriptEnabledOk() (*bool, bool)` + +GetJavascriptEnabledOk returns a tuple with the JavascriptEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJavascriptEnabled + +`func (o *ClusterDescriptionProcessArgs) SetJavascriptEnabled(v bool)` + +SetJavascriptEnabled sets JavascriptEnabled field to given value. + +### HasJavascriptEnabled + +`func (o *ClusterDescriptionProcessArgs) HasJavascriptEnabled() bool` + +HasJavascriptEnabled returns a boolean if a field has been set. + +### GetMinimumEnabledTlsProtocol + +`func (o *ClusterDescriptionProcessArgs) GetMinimumEnabledTlsProtocol() string` + +GetMinimumEnabledTlsProtocol returns the MinimumEnabledTlsProtocol field if non-nil, zero value otherwise. + +### GetMinimumEnabledTlsProtocolOk + +`func (o *ClusterDescriptionProcessArgs) GetMinimumEnabledTlsProtocolOk() (*string, bool)` + +GetMinimumEnabledTlsProtocolOk returns a tuple with the MinimumEnabledTlsProtocol field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinimumEnabledTlsProtocol + +`func (o *ClusterDescriptionProcessArgs) SetMinimumEnabledTlsProtocol(v string)` + +SetMinimumEnabledTlsProtocol sets MinimumEnabledTlsProtocol field to given value. + +### HasMinimumEnabledTlsProtocol + +`func (o *ClusterDescriptionProcessArgs) HasMinimumEnabledTlsProtocol() bool` + +HasMinimumEnabledTlsProtocol returns a boolean if a field has been set. + +### GetNoTableScan + +`func (o *ClusterDescriptionProcessArgs) GetNoTableScan() bool` + +GetNoTableScan returns the NoTableScan field if non-nil, zero value otherwise. + +### GetNoTableScanOk + +`func (o *ClusterDescriptionProcessArgs) GetNoTableScanOk() (*bool, bool)` + +GetNoTableScanOk returns a tuple with the NoTableScan field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoTableScan + +`func (o *ClusterDescriptionProcessArgs) SetNoTableScan(v bool)` + +SetNoTableScan sets NoTableScan field to given value. + +### HasNoTableScan + +`func (o *ClusterDescriptionProcessArgs) HasNoTableScan() bool` + +HasNoTableScan returns a boolean if a field has been set. + +### GetOplogMinRetentionHours + +`func (o *ClusterDescriptionProcessArgs) GetOplogMinRetentionHours() float64` + +GetOplogMinRetentionHours returns the OplogMinRetentionHours field if non-nil, zero value otherwise. + +### GetOplogMinRetentionHoursOk + +`func (o *ClusterDescriptionProcessArgs) GetOplogMinRetentionHoursOk() (*float64, bool)` + +GetOplogMinRetentionHoursOk returns a tuple with the OplogMinRetentionHours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogMinRetentionHours + +`func (o *ClusterDescriptionProcessArgs) SetOplogMinRetentionHours(v float64)` + +SetOplogMinRetentionHours sets OplogMinRetentionHours field to given value. + +### HasOplogMinRetentionHours + +`func (o *ClusterDescriptionProcessArgs) HasOplogMinRetentionHours() bool` + +HasOplogMinRetentionHours returns a boolean if a field has been set. + +### SetOplogMinRetentionHoursNil + +`func (o *ClusterDescriptionProcessArgs) SetOplogMinRetentionHoursNil(b bool)` + + SetOplogMinRetentionHoursNil sets the value for OplogMinRetentionHours to be an explicit nil + +### UnsetOplogMinRetentionHours +`func (o *ClusterDescriptionProcessArgs) UnsetOplogMinRetentionHours()` + +UnsetOplogMinRetentionHours ensures that no value is present for OplogMinRetentionHours, not even an explicit nil +### GetOplogSizeMB + +`func (o *ClusterDescriptionProcessArgs) GetOplogSizeMB() int` + +GetOplogSizeMB returns the OplogSizeMB field if non-nil, zero value otherwise. + +### GetOplogSizeMBOk + +`func (o *ClusterDescriptionProcessArgs) GetOplogSizeMBOk() (*int, bool)` + +GetOplogSizeMBOk returns a tuple with the OplogSizeMB field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogSizeMB + +`func (o *ClusterDescriptionProcessArgs) SetOplogSizeMB(v int)` + +SetOplogSizeMB sets OplogSizeMB field to given value. + +### HasOplogSizeMB + +`func (o *ClusterDescriptionProcessArgs) HasOplogSizeMB() bool` + +HasOplogSizeMB returns a boolean if a field has been set. + +### SetOplogSizeMBNil + +`func (o *ClusterDescriptionProcessArgs) SetOplogSizeMBNil(b bool)` + + SetOplogSizeMBNil sets the value for OplogSizeMB to be an explicit nil + +### UnsetOplogSizeMB +`func (o *ClusterDescriptionProcessArgs) UnsetOplogSizeMB()` + +UnsetOplogSizeMB ensures that no value is present for OplogSizeMB, not even an explicit nil +### GetSampleRefreshIntervalBIConnector + +`func (o *ClusterDescriptionProcessArgs) GetSampleRefreshIntervalBIConnector() int` + +GetSampleRefreshIntervalBIConnector returns the SampleRefreshIntervalBIConnector field if non-nil, zero value otherwise. + +### GetSampleRefreshIntervalBIConnectorOk + +`func (o *ClusterDescriptionProcessArgs) GetSampleRefreshIntervalBIConnectorOk() (*int, bool)` + +GetSampleRefreshIntervalBIConnectorOk returns a tuple with the SampleRefreshIntervalBIConnector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSampleRefreshIntervalBIConnector + +`func (o *ClusterDescriptionProcessArgs) SetSampleRefreshIntervalBIConnector(v int)` + +SetSampleRefreshIntervalBIConnector sets SampleRefreshIntervalBIConnector field to given value. + +### HasSampleRefreshIntervalBIConnector + +`func (o *ClusterDescriptionProcessArgs) HasSampleRefreshIntervalBIConnector() bool` + +HasSampleRefreshIntervalBIConnector returns a boolean if a field has been set. + +### GetSampleSizeBIConnector + +`func (o *ClusterDescriptionProcessArgs) GetSampleSizeBIConnector() int` + +GetSampleSizeBIConnector returns the SampleSizeBIConnector field if non-nil, zero value otherwise. + +### GetSampleSizeBIConnectorOk + +`func (o *ClusterDescriptionProcessArgs) GetSampleSizeBIConnectorOk() (*int, bool)` + +GetSampleSizeBIConnectorOk returns a tuple with the SampleSizeBIConnector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSampleSizeBIConnector + +`func (o *ClusterDescriptionProcessArgs) SetSampleSizeBIConnector(v int)` + +SetSampleSizeBIConnector sets SampleSizeBIConnector field to given value. + +### HasSampleSizeBIConnector + +`func (o *ClusterDescriptionProcessArgs) HasSampleSizeBIConnector() bool` + +HasSampleSizeBIConnector returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterDescriptionV15.md b/docs/docs/ClusterDescriptionV15.md new file mode 100644 index 00000000..c3cf259b --- /dev/null +++ b/docs/docs/ClusterDescriptionV15.md @@ -0,0 +1,576 @@ +# ClusterDescriptionV15 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BackupEnabled** | Pointer to **bool** | Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups. | [optional] [default to false] +**BiConnector** | Pointer to [**BiConnector**](BiConnector.md) | | [optional] +**ClusterType** | Pointer to **string** | Configuration of nodes that comprise the cluster. | [optional] +**ConnectionStrings** | Pointer to [**ClusterDescriptionConnectionStrings**](ClusterDescriptionConnectionStrings.md) | | [optional] +**CreateDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC. | [optional] [readonly] +**DiskSizeGB** | Pointer to **float64** | Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set **replicationSpecs**. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. | [optional] +**EncryptionAtRestProvider** | Pointer to **string** | Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request. | [optional] [readonly] +**Labels** | Pointer to [**[]NDSLabel**](NDSLabel.md) | Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MongoDBMajorVersion** | Pointer to **string** | Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. | [optional] [default to "6.0"] +**MongoDBVersion** | Pointer to **string** | Version of MongoDB that the cluster runs. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the advanced cluster. | [optional] +**Paused** | Pointer to **bool** | Flag that indicates whether the cluster is paused. | [optional] +**PitEnabled** | Pointer to **bool** | Flag that indicates whether the cluster uses continuous cloud backups. | [optional] +**ReplicationSpecs** | Pointer to [**[]ReplicationSpec**](ReplicationSpec.md) | List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy. | [optional] +**RootCertType** | Pointer to **string** | Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group. | [optional] [default to "ISRGROOTX1"] +**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of this cluster. | [optional] [readonly] +**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. | [optional] [default to false] +**VersionReleaseSystem** | Pointer to **string** | Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**. | [optional] [default to "LTS"] + +## Methods + +### NewClusterDescriptionV15 + +`func NewClusterDescriptionV15() *ClusterDescriptionV15` + +NewClusterDescriptionV15 instantiates a new ClusterDescriptionV15 object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterDescriptionV15WithDefaults + +`func NewClusterDescriptionV15WithDefaults() *ClusterDescriptionV15` + +NewClusterDescriptionV15WithDefaults instantiates a new ClusterDescriptionV15 object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBackupEnabled + +`func (o *ClusterDescriptionV15) GetBackupEnabled() bool` + +GetBackupEnabled returns the BackupEnabled field if non-nil, zero value otherwise. + +### GetBackupEnabledOk + +`func (o *ClusterDescriptionV15) GetBackupEnabledOk() (*bool, bool)` + +GetBackupEnabledOk returns a tuple with the BackupEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupEnabled + +`func (o *ClusterDescriptionV15) SetBackupEnabled(v bool)` + +SetBackupEnabled sets BackupEnabled field to given value. + +### HasBackupEnabled + +`func (o *ClusterDescriptionV15) HasBackupEnabled() bool` + +HasBackupEnabled returns a boolean if a field has been set. + +### GetBiConnector + +`func (o *ClusterDescriptionV15) GetBiConnector() BiConnector` + +GetBiConnector returns the BiConnector field if non-nil, zero value otherwise. + +### GetBiConnectorOk + +`func (o *ClusterDescriptionV15) GetBiConnectorOk() (*BiConnector, bool)` + +GetBiConnectorOk returns a tuple with the BiConnector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBiConnector + +`func (o *ClusterDescriptionV15) SetBiConnector(v BiConnector)` + +SetBiConnector sets BiConnector field to given value. + +### HasBiConnector + +`func (o *ClusterDescriptionV15) HasBiConnector() bool` + +HasBiConnector returns a boolean if a field has been set. + +### GetClusterType + +`func (o *ClusterDescriptionV15) GetClusterType() string` + +GetClusterType returns the ClusterType field if non-nil, zero value otherwise. + +### GetClusterTypeOk + +`func (o *ClusterDescriptionV15) GetClusterTypeOk() (*string, bool)` + +GetClusterTypeOk returns a tuple with the ClusterType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterType + +`func (o *ClusterDescriptionV15) SetClusterType(v string)` + +SetClusterType sets ClusterType field to given value. + +### HasClusterType + +`func (o *ClusterDescriptionV15) HasClusterType() bool` + +HasClusterType returns a boolean if a field has been set. + +### GetConnectionStrings + +`func (o *ClusterDescriptionV15) GetConnectionStrings() ClusterDescriptionConnectionStrings` + +GetConnectionStrings returns the ConnectionStrings field if non-nil, zero value otherwise. + +### GetConnectionStringsOk + +`func (o *ClusterDescriptionV15) GetConnectionStringsOk() (*ClusterDescriptionConnectionStrings, bool)` + +GetConnectionStringsOk returns a tuple with the ConnectionStrings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionStrings + +`func (o *ClusterDescriptionV15) SetConnectionStrings(v ClusterDescriptionConnectionStrings)` + +SetConnectionStrings sets ConnectionStrings field to given value. + +### HasConnectionStrings + +`func (o *ClusterDescriptionV15) HasConnectionStrings() bool` + +HasConnectionStrings returns a boolean if a field has been set. + +### GetCreateDate + +`func (o *ClusterDescriptionV15) GetCreateDate() time.Time` + +GetCreateDate returns the CreateDate field if non-nil, zero value otherwise. + +### GetCreateDateOk + +`func (o *ClusterDescriptionV15) GetCreateDateOk() (*time.Time, bool)` + +GetCreateDateOk returns a tuple with the CreateDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreateDate + +`func (o *ClusterDescriptionV15) SetCreateDate(v time.Time)` + +SetCreateDate sets CreateDate field to given value. + +### HasCreateDate + +`func (o *ClusterDescriptionV15) HasCreateDate() bool` + +HasCreateDate returns a boolean if a field has been set. + +### GetDiskSizeGB + +`func (o *ClusterDescriptionV15) GetDiskSizeGB() float64` + +GetDiskSizeGB returns the DiskSizeGB field if non-nil, zero value otherwise. + +### GetDiskSizeGBOk + +`func (o *ClusterDescriptionV15) GetDiskSizeGBOk() (*float64, bool)` + +GetDiskSizeGBOk returns a tuple with the DiskSizeGB field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskSizeGB + +`func (o *ClusterDescriptionV15) SetDiskSizeGB(v float64)` + +SetDiskSizeGB sets DiskSizeGB field to given value. + +### HasDiskSizeGB + +`func (o *ClusterDescriptionV15) HasDiskSizeGB() bool` + +HasDiskSizeGB returns a boolean if a field has been set. + +### GetEncryptionAtRestProvider + +`func (o *ClusterDescriptionV15) GetEncryptionAtRestProvider() string` + +GetEncryptionAtRestProvider returns the EncryptionAtRestProvider field if non-nil, zero value otherwise. + +### GetEncryptionAtRestProviderOk + +`func (o *ClusterDescriptionV15) GetEncryptionAtRestProviderOk() (*string, bool)` + +GetEncryptionAtRestProviderOk returns a tuple with the EncryptionAtRestProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionAtRestProvider + +`func (o *ClusterDescriptionV15) SetEncryptionAtRestProvider(v string)` + +SetEncryptionAtRestProvider sets EncryptionAtRestProvider field to given value. + +### HasEncryptionAtRestProvider + +`func (o *ClusterDescriptionV15) HasEncryptionAtRestProvider() bool` + +HasEncryptionAtRestProvider returns a boolean if a field has been set. + +### GetGroupId + +`func (o *ClusterDescriptionV15) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ClusterDescriptionV15) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ClusterDescriptionV15) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ClusterDescriptionV15) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ClusterDescriptionV15) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ClusterDescriptionV15) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ClusterDescriptionV15) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ClusterDescriptionV15) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLabels + +`func (o *ClusterDescriptionV15) GetLabels() []NDSLabel` + +GetLabels returns the Labels field if non-nil, zero value otherwise. + +### GetLabelsOk + +`func (o *ClusterDescriptionV15) GetLabelsOk() (*[]NDSLabel, bool)` + +GetLabelsOk returns a tuple with the Labels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabels + +`func (o *ClusterDescriptionV15) SetLabels(v []NDSLabel)` + +SetLabels sets Labels field to given value. + +### HasLabels + +`func (o *ClusterDescriptionV15) HasLabels() bool` + +HasLabels returns a boolean if a field has been set. + +### GetLinks + +`func (o *ClusterDescriptionV15) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ClusterDescriptionV15) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ClusterDescriptionV15) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ClusterDescriptionV15) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMongoDBMajorVersion + +`func (o *ClusterDescriptionV15) GetMongoDBMajorVersion() string` + +GetMongoDBMajorVersion returns the MongoDBMajorVersion field if non-nil, zero value otherwise. + +### GetMongoDBMajorVersionOk + +`func (o *ClusterDescriptionV15) GetMongoDBMajorVersionOk() (*string, bool)` + +GetMongoDBMajorVersionOk returns a tuple with the MongoDBMajorVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoDBMajorVersion + +`func (o *ClusterDescriptionV15) SetMongoDBMajorVersion(v string)` + +SetMongoDBMajorVersion sets MongoDBMajorVersion field to given value. + +### HasMongoDBMajorVersion + +`func (o *ClusterDescriptionV15) HasMongoDBMajorVersion() bool` + +HasMongoDBMajorVersion returns a boolean if a field has been set. + +### GetMongoDBVersion + +`func (o *ClusterDescriptionV15) GetMongoDBVersion() string` + +GetMongoDBVersion returns the MongoDBVersion field if non-nil, zero value otherwise. + +### GetMongoDBVersionOk + +`func (o *ClusterDescriptionV15) GetMongoDBVersionOk() (*string, bool)` + +GetMongoDBVersionOk returns a tuple with the MongoDBVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoDBVersion + +`func (o *ClusterDescriptionV15) SetMongoDBVersion(v string)` + +SetMongoDBVersion sets MongoDBVersion field to given value. + +### HasMongoDBVersion + +`func (o *ClusterDescriptionV15) HasMongoDBVersion() bool` + +HasMongoDBVersion returns a boolean if a field has been set. + +### GetName + +`func (o *ClusterDescriptionV15) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ClusterDescriptionV15) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ClusterDescriptionV15) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ClusterDescriptionV15) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPaused + +`func (o *ClusterDescriptionV15) GetPaused() bool` + +GetPaused returns the Paused field if non-nil, zero value otherwise. + +### GetPausedOk + +`func (o *ClusterDescriptionV15) GetPausedOk() (*bool, bool)` + +GetPausedOk returns a tuple with the Paused field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPaused + +`func (o *ClusterDescriptionV15) SetPaused(v bool)` + +SetPaused sets Paused field to given value. + +### HasPaused + +`func (o *ClusterDescriptionV15) HasPaused() bool` + +HasPaused returns a boolean if a field has been set. + +### GetPitEnabled + +`func (o *ClusterDescriptionV15) GetPitEnabled() bool` + +GetPitEnabled returns the PitEnabled field if non-nil, zero value otherwise. + +### GetPitEnabledOk + +`func (o *ClusterDescriptionV15) GetPitEnabledOk() (*bool, bool)` + +GetPitEnabledOk returns a tuple with the PitEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPitEnabled + +`func (o *ClusterDescriptionV15) SetPitEnabled(v bool)` + +SetPitEnabled sets PitEnabled field to given value. + +### HasPitEnabled + +`func (o *ClusterDescriptionV15) HasPitEnabled() bool` + +HasPitEnabled returns a boolean if a field has been set. + +### GetReplicationSpecs + +`func (o *ClusterDescriptionV15) GetReplicationSpecs() []ReplicationSpec` + +GetReplicationSpecs returns the ReplicationSpecs field if non-nil, zero value otherwise. + +### GetReplicationSpecsOk + +`func (o *ClusterDescriptionV15) GetReplicationSpecsOk() (*[]ReplicationSpec, bool)` + +GetReplicationSpecsOk returns a tuple with the ReplicationSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicationSpecs + +`func (o *ClusterDescriptionV15) SetReplicationSpecs(v []ReplicationSpec)` + +SetReplicationSpecs sets ReplicationSpecs field to given value. + +### HasReplicationSpecs + +`func (o *ClusterDescriptionV15) HasReplicationSpecs() bool` + +HasReplicationSpecs returns a boolean if a field has been set. + +### GetRootCertType + +`func (o *ClusterDescriptionV15) GetRootCertType() string` + +GetRootCertType returns the RootCertType field if non-nil, zero value otherwise. + +### GetRootCertTypeOk + +`func (o *ClusterDescriptionV15) GetRootCertTypeOk() (*string, bool)` + +GetRootCertTypeOk returns a tuple with the RootCertType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootCertType + +`func (o *ClusterDescriptionV15) SetRootCertType(v string)` + +SetRootCertType sets RootCertType field to given value. + +### HasRootCertType + +`func (o *ClusterDescriptionV15) HasRootCertType() bool` + +HasRootCertType returns a boolean if a field has been set. + +### GetStateName + +`func (o *ClusterDescriptionV15) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *ClusterDescriptionV15) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *ClusterDescriptionV15) SetStateName(v string)` + +SetStateName sets StateName field to given value. + +### HasStateName + +`func (o *ClusterDescriptionV15) HasStateName() bool` + +HasStateName returns a boolean if a field has been set. + +### GetTerminationProtectionEnabled + +`func (o *ClusterDescriptionV15) GetTerminationProtectionEnabled() bool` + +GetTerminationProtectionEnabled returns the TerminationProtectionEnabled field if non-nil, zero value otherwise. + +### GetTerminationProtectionEnabledOk + +`func (o *ClusterDescriptionV15) GetTerminationProtectionEnabledOk() (*bool, bool)` + +GetTerminationProtectionEnabledOk returns a tuple with the TerminationProtectionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerminationProtectionEnabled + +`func (o *ClusterDescriptionV15) SetTerminationProtectionEnabled(v bool)` + +SetTerminationProtectionEnabled sets TerminationProtectionEnabled field to given value. + +### HasTerminationProtectionEnabled + +`func (o *ClusterDescriptionV15) HasTerminationProtectionEnabled() bool` + +HasTerminationProtectionEnabled returns a boolean if a field has been set. + +### GetVersionReleaseSystem + +`func (o *ClusterDescriptionV15) GetVersionReleaseSystem() string` + +GetVersionReleaseSystem returns the VersionReleaseSystem field if non-nil, zero value otherwise. + +### GetVersionReleaseSystemOk + +`func (o *ClusterDescriptionV15) GetVersionReleaseSystemOk() (*string, bool)` + +GetVersionReleaseSystemOk returns a tuple with the VersionReleaseSystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionReleaseSystem + +`func (o *ClusterDescriptionV15) SetVersionReleaseSystem(v string)` + +SetVersionReleaseSystem sets VersionReleaseSystem field to given value. + +### HasVersionReleaseSystem + +`func (o *ClusterDescriptionV15) HasVersionReleaseSystem() bool` + +HasVersionReleaseSystem returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterEventTypeViewAlertable.md b/docs/docs/ClusterEventTypeViewAlertable.md new file mode 100644 index 00000000..a81b41e2 --- /dev/null +++ b/docs/docs/ClusterEventTypeViewAlertable.md @@ -0,0 +1,11 @@ +# ClusterEventTypeViewAlertable + +## Enum + + +* `CLUSTER_MONGOS_IS_MISSING` (value: `"CLUSTER_MONGOS_IS_MISSING"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterEventTypeViewForNdsGroup.md b/docs/docs/ClusterEventTypeViewForNdsGroup.md new file mode 100644 index 00000000..d9911c5d --- /dev/null +++ b/docs/docs/ClusterEventTypeViewForNdsGroup.md @@ -0,0 +1,13 @@ +# ClusterEventTypeViewForNdsGroup + +## Enum + + +* `PRESENT` (value: `"CLUSTER_MONGOS_IS_PRESENT"`) + +* `MISSING` (value: `"CLUSTER_MONGOS_IS_MISSING"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterEventViewForNdsGroup.md b/docs/docs/ClusterEventViewForNdsGroup.md new file mode 100644 index 00000000..eee6ef90 --- /dev/null +++ b/docs/docs/ClusterEventViewForNdsGroup.md @@ -0,0 +1,223 @@ +# ClusterEventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**ClusterEventTypeViewForNdsGroup**](ClusterEventTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] + +## Methods + +### NewClusterEventViewForNdsGroup + +`func NewClusterEventViewForNdsGroup(created time.Time, eventTypeName ClusterEventTypeViewForNdsGroup, id string, ) *ClusterEventViewForNdsGroup` + +NewClusterEventViewForNdsGroup instantiates a new ClusterEventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterEventViewForNdsGroupWithDefaults + +`func NewClusterEventViewForNdsGroupWithDefaults() *ClusterEventViewForNdsGroup` + +NewClusterEventViewForNdsGroupWithDefaults instantiates a new ClusterEventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *ClusterEventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ClusterEventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ClusterEventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *ClusterEventViewForNdsGroup) GetEventTypeName() ClusterEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ClusterEventViewForNdsGroup) GetEventTypeNameOk() (*ClusterEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ClusterEventViewForNdsGroup) SetEventTypeName(v ClusterEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ClusterEventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ClusterEventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ClusterEventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ClusterEventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ClusterEventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ClusterEventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ClusterEventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLinks + +`func (o *ClusterEventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ClusterEventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ClusterEventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ClusterEventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *ClusterEventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ClusterEventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ClusterEventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *ClusterEventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetRaw + +`func (o *ClusterEventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *ClusterEventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *ClusterEventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *ClusterEventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetShardName + +`func (o *ClusterEventViewForNdsGroup) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *ClusterEventViewForNdsGroup) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *ClusterEventViewForNdsGroup) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *ClusterEventViewForNdsGroup) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterMatcher.md b/docs/docs/ClusterMatcher.md new file mode 100644 index 00000000..f867d8d0 --- /dev/null +++ b/docs/docs/ClusterMatcher.md @@ -0,0 +1,108 @@ +# ClusterMatcher + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FieldName** | Pointer to [**ClusterMatcherField**](ClusterMatcherField.md) | | [optional] +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value against **matcher[n].value**. | [optional] +**Value** | Pointer to **string** | Value to match or exceed using the specified **matchers.operator**. | [optional] + +## Methods + +### NewClusterMatcher + +`func NewClusterMatcher() *ClusterMatcher` + +NewClusterMatcher instantiates a new ClusterMatcher object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterMatcherWithDefaults + +`func NewClusterMatcherWithDefaults() *ClusterMatcher` + +NewClusterMatcherWithDefaults instantiates a new ClusterMatcher object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFieldName + +`func (o *ClusterMatcher) GetFieldName() ClusterMatcherField` + +GetFieldName returns the FieldName field if non-nil, zero value otherwise. + +### GetFieldNameOk + +`func (o *ClusterMatcher) GetFieldNameOk() (*ClusterMatcherField, bool)` + +GetFieldNameOk returns a tuple with the FieldName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFieldName + +`func (o *ClusterMatcher) SetFieldName(v ClusterMatcherField)` + +SetFieldName sets FieldName field to given value. + +### HasFieldName + +`func (o *ClusterMatcher) HasFieldName() bool` + +HasFieldName returns a boolean if a field has been set. + +### GetOperator + +`func (o *ClusterMatcher) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ClusterMatcher) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ClusterMatcher) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ClusterMatcher) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetValue + +`func (o *ClusterMatcher) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ClusterMatcher) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ClusterMatcher) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ClusterMatcher) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterMatcherField.md b/docs/docs/ClusterMatcherField.md new file mode 100644 index 00000000..aaf37eec --- /dev/null +++ b/docs/docs/ClusterMatcherField.md @@ -0,0 +1,11 @@ +# ClusterMatcherField + +## Enum + + +* `CLUSTER_NAME` (value: `"CLUSTER_NAME"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterOutageSimulation.md b/docs/docs/ClusterOutageSimulation.md new file mode 100644 index 00000000..33c36819 --- /dev/null +++ b/docs/docs/ClusterOutageSimulation.md @@ -0,0 +1,186 @@ +# ClusterOutageSimulation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster that undergoes outage simulation. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the outage simulation. | [optional] [readonly] +**OutageFilters** | Pointer to [**[]ClusterOutageSimulationOutageFilter**](ClusterOutageSimulationOutageFilter.md) | List of settings that specify the type of cluster outage simulation. | [optional] +**StartRequestDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud started the regional outage simulation. | [optional] [readonly] +**State** | Pointer to **string** | Phase of the outage simulation. | State | Indication | |-------------|------------| | `START_REQUESTED` | User has requested cluster outage simulation.| | `STARTING` | MongoDB Cloud is starting cluster outage simulation.| | `SIMULATING` | MongoDB Cloud is simulating cluster outage.| | `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.| | `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.| | `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.| | [optional] [readonly] + +## Methods + +### NewClusterOutageSimulation + +`func NewClusterOutageSimulation() *ClusterOutageSimulation` + +NewClusterOutageSimulation instantiates a new ClusterOutageSimulation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterOutageSimulationWithDefaults + +`func NewClusterOutageSimulationWithDefaults() *ClusterOutageSimulation` + +NewClusterOutageSimulationWithDefaults instantiates a new ClusterOutageSimulation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *ClusterOutageSimulation) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *ClusterOutageSimulation) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *ClusterOutageSimulation) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *ClusterOutageSimulation) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *ClusterOutageSimulation) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ClusterOutageSimulation) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ClusterOutageSimulation) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ClusterOutageSimulation) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ClusterOutageSimulation) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ClusterOutageSimulation) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ClusterOutageSimulation) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ClusterOutageSimulation) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetOutageFilters + +`func (o *ClusterOutageSimulation) GetOutageFilters() []ClusterOutageSimulationOutageFilter` + +GetOutageFilters returns the OutageFilters field if non-nil, zero value otherwise. + +### GetOutageFiltersOk + +`func (o *ClusterOutageSimulation) GetOutageFiltersOk() (*[]ClusterOutageSimulationOutageFilter, bool)` + +GetOutageFiltersOk returns a tuple with the OutageFilters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutageFilters + +`func (o *ClusterOutageSimulation) SetOutageFilters(v []ClusterOutageSimulationOutageFilter)` + +SetOutageFilters sets OutageFilters field to given value. + +### HasOutageFilters + +`func (o *ClusterOutageSimulation) HasOutageFilters() bool` + +HasOutageFilters returns a boolean if a field has been set. + +### GetStartRequestDate + +`func (o *ClusterOutageSimulation) GetStartRequestDate() time.Time` + +GetStartRequestDate returns the StartRequestDate field if non-nil, zero value otherwise. + +### GetStartRequestDateOk + +`func (o *ClusterOutageSimulation) GetStartRequestDateOk() (*time.Time, bool)` + +GetStartRequestDateOk returns a tuple with the StartRequestDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartRequestDate + +`func (o *ClusterOutageSimulation) SetStartRequestDate(v time.Time)` + +SetStartRequestDate sets StartRequestDate field to given value. + +### HasStartRequestDate + +`func (o *ClusterOutageSimulation) HasStartRequestDate() bool` + +HasStartRequestDate returns a boolean if a field has been set. + +### GetState + +`func (o *ClusterOutageSimulation) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ClusterOutageSimulation) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ClusterOutageSimulation) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *ClusterOutageSimulation) HasState() bool` + +HasState returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterOutageSimulationApi.md b/docs/docs/ClusterOutageSimulationApi.md new file mode 100644 index 00000000..f57fefb5 --- /dev/null +++ b/docs/docs/ClusterOutageSimulationApi.md @@ -0,0 +1,244 @@ +# \ClusterOutageSimulationApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**EndOutageSimulation**](ClusterOutageSimulationApi.md#EndOutageSimulation) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation | End an Outage Simulation +[**GetOutageSimulation**](ClusterOutageSimulationApi.md#GetOutageSimulation) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation | Return One Outage Simulation +[**StartOutageSimulation**](ClusterOutageSimulationApi.md#StartOutageSimulation) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation | Start an Outage Simulation + + + +## EndOutageSimulation + +> ClusterOutageSimulation EndOutageSimulation(ctx, groupId, clusterName).Execute() + +End an Outage Simulation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.ClusterOutageSimulationApi.EndOutageSimulation(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClusterOutageSimulationApi.EndOutageSimulation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `EndOutageSimulation`: ClusterOutageSimulation + fmt.Fprintf(os.Stdout, "Response from `ClusterOutageSimulationApi.EndOutageSimulation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster that is undergoing outage simulation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEndOutageSimulationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ClusterOutageSimulation**](ClusterOutageSimulation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOutageSimulation + +> ClusterOutageSimulation GetOutageSimulation(ctx, groupId, clusterName).Execute() + +Return One Outage Simulation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.ClusterOutageSimulationApi.GetOutageSimulation(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClusterOutageSimulationApi.GetOutageSimulation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetOutageSimulation`: ClusterOutageSimulation + fmt.Fprintf(os.Stdout, "Response from `ClusterOutageSimulationApi.GetOutageSimulation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster that is undergoing outage simulation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOutageSimulationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ClusterOutageSimulation**](ClusterOutageSimulation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## StartOutageSimulation + +> ClusterOutageSimulation StartOutageSimulation(ctx, groupId, clusterName).ClusterOutageSimulation(clusterOutageSimulation).Execute() + +Start an Outage Simulation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + clusterOutageSimulation := *openapiclient.NewClusterOutageSimulation() // ClusterOutageSimulation | + + resp, r, err := sdk.ClusterOutageSimulationApi.StartOutageSimulation(context.Background(), groupId, clusterName).ClusterOutageSimulation(clusterOutageSimulation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClusterOutageSimulationApi.StartOutageSimulation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `StartOutageSimulation`: ClusterOutageSimulation + fmt.Fprintf(os.Stdout, "Response from `ClusterOutageSimulationApi.StartOutageSimulation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster to undergo an outage simulation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartOutageSimulationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **clusterOutageSimulation** | [**ClusterOutageSimulation**](ClusterOutageSimulation.md) | Describes the outage simulation. | + +### Return type + +[**ClusterOutageSimulation**](ClusterOutageSimulation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ClusterOutageSimulationOutageFilter.md b/docs/docs/ClusterOutageSimulationOutageFilter.md new file mode 100644 index 00000000..6f57acbd --- /dev/null +++ b/docs/docs/ClusterOutageSimulationOutageFilter.md @@ -0,0 +1,108 @@ +# ClusterOutageSimulationOutageFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProvider** | Pointer to **string** | The cloud provider of the region that undergoes the outage simulation. | [optional] +**RegionName** | Pointer to **string** | The name of the region to undergo an outage simulation. | [optional] +**Type** | Pointer to **string** | The type of cluster outage to simulate. | Type | Description | |------------|-------------| | `REGION` | Simulates a cluster outage for a region.| | [optional] + +## Methods + +### NewClusterOutageSimulationOutageFilter + +`func NewClusterOutageSimulationOutageFilter() *ClusterOutageSimulationOutageFilter` + +NewClusterOutageSimulationOutageFilter instantiates a new ClusterOutageSimulationOutageFilter object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterOutageSimulationOutageFilterWithDefaults + +`func NewClusterOutageSimulationOutageFilterWithDefaults() *ClusterOutageSimulationOutageFilter` + +NewClusterOutageSimulationOutageFilterWithDefaults instantiates a new ClusterOutageSimulationOutageFilter object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProvider + +`func (o *ClusterOutageSimulationOutageFilter) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *ClusterOutageSimulationOutageFilter) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *ClusterOutageSimulationOutageFilter) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + +### HasCloudProvider + +`func (o *ClusterOutageSimulationOutageFilter) HasCloudProvider() bool` + +HasCloudProvider returns a boolean if a field has been set. + +### GetRegionName + +`func (o *ClusterOutageSimulationOutageFilter) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *ClusterOutageSimulationOutageFilter) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *ClusterOutageSimulationOutageFilter) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *ClusterOutageSimulationOutageFilter) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetType + +`func (o *ClusterOutageSimulationOutageFilter) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ClusterOutageSimulationOutageFilter) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ClusterOutageSimulationOutageFilter) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ClusterOutageSimulationOutageFilter) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterProviderSettings.md b/docs/docs/ClusterProviderSettings.md new file mode 100644 index 00000000..cc015c63 --- /dev/null +++ b/docs/docs/ClusterProviderSettings.md @@ -0,0 +1,259 @@ +# ClusterProviderSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoScaling** | Pointer to [**FreeAutoScaling**](FreeAutoScaling.md) | | [optional] +**DiskIOPS** | Pointer to **int** | Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform. | [optional] +**EncryptEBSVolume** | Pointer to **bool** | Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled. | [optional] [default to true] +**InstanceSizeName** | Pointer to **string** | Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**. | [optional] +**RegionName** | Pointer to **string** | Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**. | [optional] +**VolumeType** | Pointer to **string** | Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS</abbr>. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). | [optional] +**ProviderName** | **string** | | +**DiskTypeName** | Pointer to **string** | Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies. | [optional] +**BackingProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M2` or `M5`. | [optional] + +## Methods + +### NewClusterProviderSettings + +`func NewClusterProviderSettings(providerName string, ) *ClusterProviderSettings` + +NewClusterProviderSettings instantiates a new ClusterProviderSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterProviderSettingsWithDefaults + +`func NewClusterProviderSettingsWithDefaults() *ClusterProviderSettings` + +NewClusterProviderSettingsWithDefaults instantiates a new ClusterProviderSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoScaling + +`func (o *ClusterProviderSettings) GetAutoScaling() FreeAutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *ClusterProviderSettings) GetAutoScalingOk() (*FreeAutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *ClusterProviderSettings) SetAutoScaling(v FreeAutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *ClusterProviderSettings) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetDiskIOPS + +`func (o *ClusterProviderSettings) GetDiskIOPS() int` + +GetDiskIOPS returns the DiskIOPS field if non-nil, zero value otherwise. + +### GetDiskIOPSOk + +`func (o *ClusterProviderSettings) GetDiskIOPSOk() (*int, bool)` + +GetDiskIOPSOk returns a tuple with the DiskIOPS field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskIOPS + +`func (o *ClusterProviderSettings) SetDiskIOPS(v int)` + +SetDiskIOPS sets DiskIOPS field to given value. + +### HasDiskIOPS + +`func (o *ClusterProviderSettings) HasDiskIOPS() bool` + +HasDiskIOPS returns a boolean if a field has been set. + +### GetEncryptEBSVolume + +`func (o *ClusterProviderSettings) GetEncryptEBSVolume() bool` + +GetEncryptEBSVolume returns the EncryptEBSVolume field if non-nil, zero value otherwise. + +### GetEncryptEBSVolumeOk + +`func (o *ClusterProviderSettings) GetEncryptEBSVolumeOk() (*bool, bool)` + +GetEncryptEBSVolumeOk returns a tuple with the EncryptEBSVolume field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptEBSVolume + +`func (o *ClusterProviderSettings) SetEncryptEBSVolume(v bool)` + +SetEncryptEBSVolume sets EncryptEBSVolume field to given value. + +### HasEncryptEBSVolume + +`func (o *ClusterProviderSettings) HasEncryptEBSVolume() bool` + +HasEncryptEBSVolume returns a boolean if a field has been set. + +### GetInstanceSizeName + +`func (o *ClusterProviderSettings) GetInstanceSizeName() string` + +GetInstanceSizeName returns the InstanceSizeName field if non-nil, zero value otherwise. + +### GetInstanceSizeNameOk + +`func (o *ClusterProviderSettings) GetInstanceSizeNameOk() (*string, bool)` + +GetInstanceSizeNameOk returns a tuple with the InstanceSizeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSizeName + +`func (o *ClusterProviderSettings) SetInstanceSizeName(v string)` + +SetInstanceSizeName sets InstanceSizeName field to given value. + +### HasInstanceSizeName + +`func (o *ClusterProviderSettings) HasInstanceSizeName() bool` + +HasInstanceSizeName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *ClusterProviderSettings) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *ClusterProviderSettings) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *ClusterProviderSettings) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *ClusterProviderSettings) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetVolumeType + +`func (o *ClusterProviderSettings) GetVolumeType() string` + +GetVolumeType returns the VolumeType field if non-nil, zero value otherwise. + +### GetVolumeTypeOk + +`func (o *ClusterProviderSettings) GetVolumeTypeOk() (*string, bool)` + +GetVolumeTypeOk returns a tuple with the VolumeType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVolumeType + +`func (o *ClusterProviderSettings) SetVolumeType(v string)` + +SetVolumeType sets VolumeType field to given value. + +### HasVolumeType + +`func (o *ClusterProviderSettings) HasVolumeType() bool` + +HasVolumeType returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ClusterProviderSettings) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ClusterProviderSettings) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ClusterProviderSettings) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetDiskTypeName + +`func (o *ClusterProviderSettings) GetDiskTypeName() string` + +GetDiskTypeName returns the DiskTypeName field if non-nil, zero value otherwise. + +### GetDiskTypeNameOk + +`func (o *ClusterProviderSettings) GetDiskTypeNameOk() (*string, bool)` + +GetDiskTypeNameOk returns a tuple with the DiskTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskTypeName + +`func (o *ClusterProviderSettings) SetDiskTypeName(v string)` + +SetDiskTypeName sets DiskTypeName field to given value. + +### HasDiskTypeName + +`func (o *ClusterProviderSettings) HasDiskTypeName() bool` + +HasDiskTypeName returns a boolean if a field has been set. + +### GetBackingProviderName + +`func (o *ClusterProviderSettings) GetBackingProviderName() string` + +GetBackingProviderName returns the BackingProviderName field if non-nil, zero value otherwise. + +### GetBackingProviderNameOk + +`func (o *ClusterProviderSettings) GetBackingProviderNameOk() (*string, bool)` + +GetBackingProviderNameOk returns a tuple with the BackingProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackingProviderName + +`func (o *ClusterProviderSettings) SetBackingProviderName(v string)` + +SetBackingProviderName sets BackingProviderName field to given value. + +### HasBackingProviderName + +`func (o *ClusterProviderSettings) HasBackingProviderName() bool` + +HasBackingProviderName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClusterStatus.md b/docs/docs/ClusterStatus.md new file mode 100644 index 00000000..1bd5a5f0 --- /dev/null +++ b/docs/docs/ClusterStatus.md @@ -0,0 +1,82 @@ +# ClusterStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ChangeStatus** | Pointer to **string** | State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewClusterStatus + +`func NewClusterStatus() *ClusterStatus` + +NewClusterStatus instantiates a new ClusterStatus object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewClusterStatusWithDefaults + +`func NewClusterStatusWithDefaults() *ClusterStatus` + +NewClusterStatusWithDefaults instantiates a new ClusterStatus object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetChangeStatus + +`func (o *ClusterStatus) GetChangeStatus() string` + +GetChangeStatus returns the ChangeStatus field if non-nil, zero value otherwise. + +### GetChangeStatusOk + +`func (o *ClusterStatus) GetChangeStatusOk() (*string, bool)` + +GetChangeStatusOk returns a tuple with the ChangeStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChangeStatus + +`func (o *ClusterStatus) SetChangeStatus(v string)` + +SetChangeStatus sets ChangeStatus field to given value. + +### HasChangeStatus + +`func (o *ClusterStatus) HasChangeStatus() bool` + +HasChangeStatus returns a boolean if a field has been set. + +### GetLinks + +`func (o *ClusterStatus) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ClusterStatus) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ClusterStatus) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ClusterStatus) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ClustersApi.md b/docs/docs/ClustersApi.md new file mode 100644 index 00000000..fb7039a8 --- /dev/null +++ b/docs/docs/ClustersApi.md @@ -0,0 +1,716 @@ +# \ClustersApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetClusterAdvancedConfiguration**](ClustersApi.md#GetClusterAdvancedConfiguration) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs | Return One Advanced Configuration Options for One Cluster +[**GetClusterStatus**](ClustersApi.md#GetClusterStatus) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status | Return Status of All Cluster Operations +[**GetSampleDatasetLoadStatus**](ClustersApi.md#GetSampleDatasetLoadStatus) | **Get** /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId} | Check Status of Cluster Sample Dataset Request +[**ListCloudProviderRegions**](ClustersApi.md#ListCloudProviderRegions) | **Get** /api/atlas/v2/groups/{groupId}/clusters/provider/regions | Return All Cloud Provider Regions +[**ListClustersForAllProjects**](ClustersApi.md#ListClustersForAllProjects) | **Get** /api/atlas/v2/clusters | Return All Authorized Clusters in All Projects +[**LoadSampleDataset**](ClustersApi.md#LoadSampleDataset) | **Post** /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name} | Load Sample Dataset Request into Cluster +[**UpdateClusterAdvancedConfiguration**](ClustersApi.md#UpdateClusterAdvancedConfiguration) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs | Update Advanced Configuration Options for One Cluster +[**UpgradeSharedCluster**](ClustersApi.md#UpgradeSharedCluster) | **Post** /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade | Upgrade One Shared-tier Cluster +[**UpgradeSharedClusterToServerless**](ClustersApi.md#UpgradeSharedClusterToServerless) | **Post** /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless | Upgrades One Shared-Tier Cluster to the Serverless Instance + + + +## GetClusterAdvancedConfiguration + +> ClusterDescriptionProcessArgs GetClusterAdvancedConfiguration(ctx, groupId, clusterName).Execute() + +Return One Advanced Configuration Options for One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.ClustersApi.GetClusterAdvancedConfiguration(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.GetClusterAdvancedConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetClusterAdvancedConfiguration`: ClusterDescriptionProcessArgs + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.GetClusterAdvancedConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetClusterAdvancedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ClusterDescriptionProcessArgs**](ClusterDescriptionProcessArgs.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetClusterStatus + +> ClusterStatus GetClusterStatus(ctx, groupId, clusterName).Execute() + +Return Status of All Cluster Operations + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.ClustersApi.GetClusterStatus(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.GetClusterStatus``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetClusterStatus`: ClusterStatus + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.GetClusterStatus`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetClusterStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ClusterStatus**](ClusterStatus.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetSampleDatasetLoadStatus + +> SampleDatasetStatus GetSampleDatasetLoadStatus(ctx, groupId, sampleDatasetId).Execute() + +Check Status of Cluster Sample Dataset Request + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + sampleDatasetId := "sampleDatasetId_example" // string | + + resp, r, err := sdk.ClustersApi.GetSampleDatasetLoadStatus(context.Background(), groupId, sampleDatasetId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.GetSampleDatasetLoadStatus``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetSampleDatasetLoadStatus`: SampleDatasetStatus + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.GetSampleDatasetLoadStatus`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**sampleDatasetId** | **string** | Unique 24-hexadecimal digit string that identifies the loaded sample dataset. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSampleDatasetLoadStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**SampleDatasetStatus**](SampleDatasetStatus.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListCloudProviderRegions + +> PaginatedApiAtlasProviderRegions ListCloudProviderRegions(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Providers(providers).Tier(tier).Execute() + +Return All Cloud Provider Regions + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + providers := []string{"Inner_example"} // []string | (optional) + tier := "tier_example" // string | (optional) + + resp, r, err := sdk.ClustersApi.ListCloudProviderRegions(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Providers(providers).Tier(tier).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.ListCloudProviderRegions``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListCloudProviderRegions`: PaginatedApiAtlasProviderRegions + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ListCloudProviderRegions`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCloudProviderRegionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **providers** | **[]string** | Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters. | + **tier** | **string** | Cluster tier for which to retrieve the regions. | + +### Return type + +[**PaginatedApiAtlasProviderRegions**](PaginatedApiAtlasProviderRegions.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListClustersForAllProjects + +> PaginatedOrgGroup ListClustersForAllProjects(ctx).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Authorized Clusters in All Projects + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ClustersApi.ListClustersForAllProjects(context.Background()).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.ListClustersForAllProjects``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListClustersForAllProjects`: PaginatedOrgGroup + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ListClustersForAllProjects`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListClustersForAllProjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedOrgGroup**](PaginatedOrgGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## LoadSampleDataset + +> []SampleDatasetStatus LoadSampleDataset(ctx, groupId, name).SampleDatasetStatus(sampleDatasetStatus).Execute() + +Load Sample Dataset Request into Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + name := "name_example" // string | + sampleDatasetStatus := *openapiclient.NewSampleDatasetStatus() // SampleDatasetStatus | + + resp, r, err := sdk.ClustersApi.LoadSampleDataset(context.Background(), groupId, name).SampleDatasetStatus(sampleDatasetStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.LoadSampleDataset``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `LoadSampleDataset`: []SampleDatasetStatus + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.LoadSampleDataset`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**name** | **string** | Human-readable label that identifies the cluster into which you load the sample dataset. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiLoadSampleDatasetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **sampleDatasetStatus** | [**SampleDatasetStatus**](SampleDatasetStatus.md) | Cluster into which to load the sample dataset. | + +### Return type + +[**[]SampleDatasetStatus**](SampleDatasetStatus.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateClusterAdvancedConfiguration + +> ClusterDescriptionProcessArgs UpdateClusterAdvancedConfiguration(ctx, groupId, clusterName).ClusterDescriptionProcessArgs(clusterDescriptionProcessArgs).Execute() + +Update Advanced Configuration Options for One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + clusterDescriptionProcessArgs := *openapiclient.NewClusterDescriptionProcessArgs() // ClusterDescriptionProcessArgs | + + resp, r, err := sdk.ClustersApi.UpdateClusterAdvancedConfiguration(context.Background(), groupId, clusterName).ClusterDescriptionProcessArgs(clusterDescriptionProcessArgs).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.UpdateClusterAdvancedConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateClusterAdvancedConfiguration`: ClusterDescriptionProcessArgs + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.UpdateClusterAdvancedConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateClusterAdvancedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **clusterDescriptionProcessArgs** | [**ClusterDescriptionProcessArgs**](ClusterDescriptionProcessArgs.md) | Advanced configuration details to add for one cluster in the specified project. | + +### Return type + +[**ClusterDescriptionProcessArgs**](ClusterDescriptionProcessArgs.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpgradeSharedCluster + +> LegacyClusterDescription UpgradeSharedCluster(ctx, groupId).LegacyClusterDescription(legacyClusterDescription).Execute() + +Upgrade One Shared-tier Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + legacyClusterDescription := *openapiclient.NewLegacyClusterDescription() // LegacyClusterDescription | + + resp, r, err := sdk.ClustersApi.UpgradeSharedCluster(context.Background(), groupId).LegacyClusterDescription(legacyClusterDescription).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.UpgradeSharedCluster``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpgradeSharedCluster`: LegacyClusterDescription + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.UpgradeSharedCluster`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpgradeSharedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **legacyClusterDescription** | [**LegacyClusterDescription**](LegacyClusterDescription.md) | Details of the shared-tier cluster upgrade in the specified project. | + +### Return type + +[**LegacyClusterDescription**](LegacyClusterDescription.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpgradeSharedClusterToServerless + +> ServerlessInstanceDescription UpgradeSharedClusterToServerless(ctx, groupId).ServerlessInstanceDescription(serverlessInstanceDescription).Execute() + +Upgrades One Shared-Tier Cluster to the Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + serverlessInstanceDescription := *openapiclient.NewServerlessInstanceDescription(*openapiclient.NewServerlessProviderSettings("BackingProviderName_example", "RegionName_example")) // ServerlessInstanceDescription | + + resp, r, err := sdk.ClustersApi.UpgradeSharedClusterToServerless(context.Background(), groupId).ServerlessInstanceDescription(serverlessInstanceDescription).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.UpgradeSharedClusterToServerless``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpgradeSharedClusterToServerless`: ServerlessInstanceDescription + fmt.Fprintf(os.Stdout, "Response from `ClustersApi.UpgradeSharedClusterToServerless`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpgradeSharedClusterToServerlessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **serverlessInstanceDescription** | [**ServerlessInstanceDescription**](ServerlessInstanceDescription.md) | Details of the shared-tier cluster upgrade in the specified project. | + +### Return type + +[**ServerlessInstanceDescription**](ServerlessInstanceDescription.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/Collation.md b/docs/docs/Collation.md new file mode 100644 index 00000000..75344794 --- /dev/null +++ b/docs/docs/Collation.md @@ -0,0 +1,259 @@ +# Collation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Alternate** | Pointer to **string** | Method to handle whitespace and punctuation as base characters for purposes of comparison. | Value | Evaluate Whitespace and Punctuation as Base Characters | |---|---| | `\"non-ignorable\"` | Yes | | `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. | | [optional] [default to "non-ignorable"] +**Backwards** | Pointer to **bool** | Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way. | Value | String Comparison Method | |---|---| | `true` | Compare from back to front. | | `false` | Compare from front to back. | | [optional] [default to false] +**CaseFirst** | Pointer to **string** | Method to handle sort order of case differences during tertiary level comparisons. | Value | Sort Order Method | |---|---| | `\"upper\"` | Uppercase sorts before lowercase. | | `\"lower\"` | Lowercase sorts before uppercase. | | `\"off\"` | Similar to \"lower\" with slight differences. | | [optional] [default to "false"] +**CaseLevel** | Pointer to **bool** | Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`. | Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include | |---|---|---|---| | true | Yes | 1 | Base characters and case. | | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. | | false | No | | | | [optional] [default to false] +**Locale** | **string** | International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`. | +**MaxVariable** | Pointer to **string** | Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`. | Value | Ignore | |---|---| | `\"punct\"` | Both whitespace and punctuation | | `\"space\"` | Whitespace | | [optional] +**Normalization** | Pointer to **bool** | Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing. | Value | Normalization Method | |---|---| | `true` | Yes, check if fully normalized and perform normalization to compare text. | | `false` | No, don't check. | | [optional] [default to false] +**NumericOrdering** | Pointer to **bool** | Flag that indicates whether to compare sequences of digits as numbers or as strings. | Value | Comparison Method | |---|---| | `true` | Compare as numbers. This results in `10 > 2`. | | `false` | Compare as strings. This results in `\"10\" < \"2\"`. | | [optional] [default to false] +**Strength** | Pointer to **int** | Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values: | Value | Comparison Level | Comparison Method | |---|---|---| | 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. | | 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. | | 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. | | 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. | | 5 | Identical | Compares for the specific use case of tie breaker. | | [optional] [default to 3] + +## Methods + +### NewCollation + +`func NewCollation(locale string, ) *Collation` + +NewCollation instantiates a new Collation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCollationWithDefaults + +`func NewCollationWithDefaults() *Collation` + +NewCollationWithDefaults instantiates a new Collation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAlternate + +`func (o *Collation) GetAlternate() string` + +GetAlternate returns the Alternate field if non-nil, zero value otherwise. + +### GetAlternateOk + +`func (o *Collation) GetAlternateOk() (*string, bool)` + +GetAlternateOk returns a tuple with the Alternate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlternate + +`func (o *Collation) SetAlternate(v string)` + +SetAlternate sets Alternate field to given value. + +### HasAlternate + +`func (o *Collation) HasAlternate() bool` + +HasAlternate returns a boolean if a field has been set. + +### GetBackwards + +`func (o *Collation) GetBackwards() bool` + +GetBackwards returns the Backwards field if non-nil, zero value otherwise. + +### GetBackwardsOk + +`func (o *Collation) GetBackwardsOk() (*bool, bool)` + +GetBackwardsOk returns a tuple with the Backwards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackwards + +`func (o *Collation) SetBackwards(v bool)` + +SetBackwards sets Backwards field to given value. + +### HasBackwards + +`func (o *Collation) HasBackwards() bool` + +HasBackwards returns a boolean if a field has been set. + +### GetCaseFirst + +`func (o *Collation) GetCaseFirst() string` + +GetCaseFirst returns the CaseFirst field if non-nil, zero value otherwise. + +### GetCaseFirstOk + +`func (o *Collation) GetCaseFirstOk() (*string, bool)` + +GetCaseFirstOk returns a tuple with the CaseFirst field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCaseFirst + +`func (o *Collation) SetCaseFirst(v string)` + +SetCaseFirst sets CaseFirst field to given value. + +### HasCaseFirst + +`func (o *Collation) HasCaseFirst() bool` + +HasCaseFirst returns a boolean if a field has been set. + +### GetCaseLevel + +`func (o *Collation) GetCaseLevel() bool` + +GetCaseLevel returns the CaseLevel field if non-nil, zero value otherwise. + +### GetCaseLevelOk + +`func (o *Collation) GetCaseLevelOk() (*bool, bool)` + +GetCaseLevelOk returns a tuple with the CaseLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCaseLevel + +`func (o *Collation) SetCaseLevel(v bool)` + +SetCaseLevel sets CaseLevel field to given value. + +### HasCaseLevel + +`func (o *Collation) HasCaseLevel() bool` + +HasCaseLevel returns a boolean if a field has been set. + +### GetLocale + +`func (o *Collation) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *Collation) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *Collation) SetLocale(v string)` + +SetLocale sets Locale field to given value. + + +### GetMaxVariable + +`func (o *Collation) GetMaxVariable() string` + +GetMaxVariable returns the MaxVariable field if non-nil, zero value otherwise. + +### GetMaxVariableOk + +`func (o *Collation) GetMaxVariableOk() (*string, bool)` + +GetMaxVariableOk returns a tuple with the MaxVariable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxVariable + +`func (o *Collation) SetMaxVariable(v string)` + +SetMaxVariable sets MaxVariable field to given value. + +### HasMaxVariable + +`func (o *Collation) HasMaxVariable() bool` + +HasMaxVariable returns a boolean if a field has been set. + +### GetNormalization + +`func (o *Collation) GetNormalization() bool` + +GetNormalization returns the Normalization field if non-nil, zero value otherwise. + +### GetNormalizationOk + +`func (o *Collation) GetNormalizationOk() (*bool, bool)` + +GetNormalizationOk returns a tuple with the Normalization field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNormalization + +`func (o *Collation) SetNormalization(v bool)` + +SetNormalization sets Normalization field to given value. + +### HasNormalization + +`func (o *Collation) HasNormalization() bool` + +HasNormalization returns a boolean if a field has been set. + +### GetNumericOrdering + +`func (o *Collation) GetNumericOrdering() bool` + +GetNumericOrdering returns the NumericOrdering field if non-nil, zero value otherwise. + +### GetNumericOrderingOk + +`func (o *Collation) GetNumericOrderingOk() (*bool, bool)` + +GetNumericOrderingOk returns a tuple with the NumericOrdering field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumericOrdering + +`func (o *Collation) SetNumericOrdering(v bool)` + +SetNumericOrdering sets NumericOrdering field to given value. + +### HasNumericOrdering + +`func (o *Collation) HasNumericOrdering() bool` + +HasNumericOrdering returns a boolean if a field has been set. + +### GetStrength + +`func (o *Collation) GetStrength() int` + +GetStrength returns the Strength field if non-nil, zero value otherwise. + +### GetStrengthOk + +`func (o *Collation) GetStrengthOk() (*int, bool)` + +GetStrengthOk returns a tuple with the Strength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrength + +`func (o *Collation) SetStrength(v int)` + +SetStrength sets Strength field to given value. + +### HasStrength + +`func (o *Collation) HasStrength() bool` + +HasStrength returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ComputeAutoScaling.md b/docs/docs/ComputeAutoScaling.md new file mode 100644 index 00000000..0d865cb4 --- /dev/null +++ b/docs/docs/ComputeAutoScaling.md @@ -0,0 +1,82 @@ +# ComputeAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling. | [optional] +**ScaleDownEnabled** | Pointer to **bool** | Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**. | [optional] + +## Methods + +### NewComputeAutoScaling + +`func NewComputeAutoScaling() *ComputeAutoScaling` + +NewComputeAutoScaling instantiates a new ComputeAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewComputeAutoScalingWithDefaults + +`func NewComputeAutoScalingWithDefaults() *ComputeAutoScaling` + +NewComputeAutoScalingWithDefaults instantiates a new ComputeAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *ComputeAutoScaling) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ComputeAutoScaling) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ComputeAutoScaling) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ComputeAutoScaling) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetScaleDownEnabled + +`func (o *ComputeAutoScaling) GetScaleDownEnabled() bool` + +GetScaleDownEnabled returns the ScaleDownEnabled field if non-nil, zero value otherwise. + +### GetScaleDownEnabledOk + +`func (o *ComputeAutoScaling) GetScaleDownEnabledOk() (*bool, bool)` + +GetScaleDownEnabledOk returns a tuple with the ScaleDownEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScaleDownEnabled + +`func (o *ComputeAutoScaling) SetScaleDownEnabled(v bool)` + +SetScaleDownEnabled sets ScaleDownEnabled field to given value. + +### HasScaleDownEnabled + +`func (o *ComputeAutoScaling) HasScaleDownEnabled() bool` + +HasScaleDownEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ComputeAutoScalingV15.md b/docs/docs/ComputeAutoScalingV15.md new file mode 100644 index 00000000..16771203 --- /dev/null +++ b/docs/docs/ComputeAutoScalingV15.md @@ -0,0 +1,134 @@ +# ComputeAutoScalingV15 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled instance size auto-scaling. - Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**. - Set to `false` to disable instance size automatic scaling. | [optional] +**MaxInstanceSize** | Pointer to [**InstanceSize**](InstanceSize.md) | | [optional] +**MinInstanceSize** | Pointer to [**InstanceSize**](InstanceSize.md) | | [optional] +**ScaleDownEnabled** | Pointer to **bool** | Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**. | [optional] + +## Methods + +### NewComputeAutoScalingV15 + +`func NewComputeAutoScalingV15() *ComputeAutoScalingV15` + +NewComputeAutoScalingV15 instantiates a new ComputeAutoScalingV15 object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewComputeAutoScalingV15WithDefaults + +`func NewComputeAutoScalingV15WithDefaults() *ComputeAutoScalingV15` + +NewComputeAutoScalingV15WithDefaults instantiates a new ComputeAutoScalingV15 object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *ComputeAutoScalingV15) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ComputeAutoScalingV15) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ComputeAutoScalingV15) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ComputeAutoScalingV15) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetMaxInstanceSize + +`func (o *ComputeAutoScalingV15) GetMaxInstanceSize() InstanceSize` + +GetMaxInstanceSize returns the MaxInstanceSize field if non-nil, zero value otherwise. + +### GetMaxInstanceSizeOk + +`func (o *ComputeAutoScalingV15) GetMaxInstanceSizeOk() (*InstanceSize, bool)` + +GetMaxInstanceSizeOk returns a tuple with the MaxInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxInstanceSize + +`func (o *ComputeAutoScalingV15) SetMaxInstanceSize(v InstanceSize)` + +SetMaxInstanceSize sets MaxInstanceSize field to given value. + +### HasMaxInstanceSize + +`func (o *ComputeAutoScalingV15) HasMaxInstanceSize() bool` + +HasMaxInstanceSize returns a boolean if a field has been set. + +### GetMinInstanceSize + +`func (o *ComputeAutoScalingV15) GetMinInstanceSize() InstanceSize` + +GetMinInstanceSize returns the MinInstanceSize field if non-nil, zero value otherwise. + +### GetMinInstanceSizeOk + +`func (o *ComputeAutoScalingV15) GetMinInstanceSizeOk() (*InstanceSize, bool)` + +GetMinInstanceSizeOk returns a tuple with the MinInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinInstanceSize + +`func (o *ComputeAutoScalingV15) SetMinInstanceSize(v InstanceSize)` + +SetMinInstanceSize sets MinInstanceSize field to given value. + +### HasMinInstanceSize + +`func (o *ComputeAutoScalingV15) HasMinInstanceSize() bool` + +HasMinInstanceSize returns a boolean if a field has been set. + +### GetScaleDownEnabled + +`func (o *ComputeAutoScalingV15) GetScaleDownEnabled() bool` + +GetScaleDownEnabled returns the ScaleDownEnabled field if non-nil, zero value otherwise. + +### GetScaleDownEnabledOk + +`func (o *ComputeAutoScalingV15) GetScaleDownEnabledOk() (*bool, bool)` + +GetScaleDownEnabledOk returns a tuple with the ScaleDownEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScaleDownEnabled + +`func (o *ComputeAutoScalingV15) SetScaleDownEnabled(v bool)` + +SetScaleDownEnabled sets ScaleDownEnabled field to given value. + +### HasScaleDownEnabled + +`func (o *ComputeAutoScalingV15) HasScaleDownEnabled() bool` + +HasScaleDownEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ConnectedOrgConfig.md b/docs/docs/ConnectedOrgConfig.md new file mode 100644 index 00000000..3c955967 --- /dev/null +++ b/docs/docs/ConnectedOrgConfig.md @@ -0,0 +1,197 @@ +# ConnectedOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DomainAllowList** | Pointer to **[]string** | Approved domains that restrict users who can join the organization based on their email address. | [optional] +**DomainRestrictionEnabled** | **bool** | Value that indicates whether domain restriction is enabled for this connected org. | +**IdentityProviderId** | **string** | Unique 20-hexadecimal digit string that identifies the identity provider that this connected org config is associated with. | +**OrgId** | **string** | Unique 24-hexadecimal digit string that identifies the connected organization configuration. | [readonly] +**PostAuthRoleGrants** | Pointer to **[]string** | Atlas roles that are granted to a user in this organization after authenticating. | [optional] +**RoleMappings** | Pointer to [**[]RoleMapping**](RoleMapping.md) | Role mappings that are configured in this organization. | [optional] +**UserConflicts** | Pointer to [**[]FederatedUser**](FederatedUser.md) | List that contains the users who have an email address that doesn't match any domain on the allowed list. | [optional] + +## Methods + +### NewConnectedOrgConfig + +`func NewConnectedOrgConfig(domainRestrictionEnabled bool, identityProviderId string, orgId string, ) *ConnectedOrgConfig` + +NewConnectedOrgConfig instantiates a new ConnectedOrgConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewConnectedOrgConfigWithDefaults + +`func NewConnectedOrgConfigWithDefaults() *ConnectedOrgConfig` + +NewConnectedOrgConfigWithDefaults instantiates a new ConnectedOrgConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDomainAllowList + +`func (o *ConnectedOrgConfig) GetDomainAllowList() []string` + +GetDomainAllowList returns the DomainAllowList field if non-nil, zero value otherwise. + +### GetDomainAllowListOk + +`func (o *ConnectedOrgConfig) GetDomainAllowListOk() (*[]string, bool)` + +GetDomainAllowListOk returns a tuple with the DomainAllowList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomainAllowList + +`func (o *ConnectedOrgConfig) SetDomainAllowList(v []string)` + +SetDomainAllowList sets DomainAllowList field to given value. + +### HasDomainAllowList + +`func (o *ConnectedOrgConfig) HasDomainAllowList() bool` + +HasDomainAllowList returns a boolean if a field has been set. + +### GetDomainRestrictionEnabled + +`func (o *ConnectedOrgConfig) GetDomainRestrictionEnabled() bool` + +GetDomainRestrictionEnabled returns the DomainRestrictionEnabled field if non-nil, zero value otherwise. + +### GetDomainRestrictionEnabledOk + +`func (o *ConnectedOrgConfig) GetDomainRestrictionEnabledOk() (*bool, bool)` + +GetDomainRestrictionEnabledOk returns a tuple with the DomainRestrictionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomainRestrictionEnabled + +`func (o *ConnectedOrgConfig) SetDomainRestrictionEnabled(v bool)` + +SetDomainRestrictionEnabled sets DomainRestrictionEnabled field to given value. + + +### GetIdentityProviderId + +`func (o *ConnectedOrgConfig) GetIdentityProviderId() string` + +GetIdentityProviderId returns the IdentityProviderId field if non-nil, zero value otherwise. + +### GetIdentityProviderIdOk + +`func (o *ConnectedOrgConfig) GetIdentityProviderIdOk() (*string, bool)` + +GetIdentityProviderIdOk returns a tuple with the IdentityProviderId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProviderId + +`func (o *ConnectedOrgConfig) SetIdentityProviderId(v string)` + +SetIdentityProviderId sets IdentityProviderId field to given value. + + +### GetOrgId + +`func (o *ConnectedOrgConfig) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ConnectedOrgConfig) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ConnectedOrgConfig) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + + +### GetPostAuthRoleGrants + +`func (o *ConnectedOrgConfig) GetPostAuthRoleGrants() []string` + +GetPostAuthRoleGrants returns the PostAuthRoleGrants field if non-nil, zero value otherwise. + +### GetPostAuthRoleGrantsOk + +`func (o *ConnectedOrgConfig) GetPostAuthRoleGrantsOk() (*[]string, bool)` + +GetPostAuthRoleGrantsOk returns a tuple with the PostAuthRoleGrants field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPostAuthRoleGrants + +`func (o *ConnectedOrgConfig) SetPostAuthRoleGrants(v []string)` + +SetPostAuthRoleGrants sets PostAuthRoleGrants field to given value. + +### HasPostAuthRoleGrants + +`func (o *ConnectedOrgConfig) HasPostAuthRoleGrants() bool` + +HasPostAuthRoleGrants returns a boolean if a field has been set. + +### GetRoleMappings + +`func (o *ConnectedOrgConfig) GetRoleMappings() []RoleMapping` + +GetRoleMappings returns the RoleMappings field if non-nil, zero value otherwise. + +### GetRoleMappingsOk + +`func (o *ConnectedOrgConfig) GetRoleMappingsOk() (*[]RoleMapping, bool)` + +GetRoleMappingsOk returns a tuple with the RoleMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleMappings + +`func (o *ConnectedOrgConfig) SetRoleMappings(v []RoleMapping)` + +SetRoleMappings sets RoleMappings field to given value. + +### HasRoleMappings + +`func (o *ConnectedOrgConfig) HasRoleMappings() bool` + +HasRoleMappings returns a boolean if a field has been set. + +### GetUserConflicts + +`func (o *ConnectedOrgConfig) GetUserConflicts() []FederatedUser` + +GetUserConflicts returns the UserConflicts field if non-nil, zero value otherwise. + +### GetUserConflictsOk + +`func (o *ConnectedOrgConfig) GetUserConflictsOk() (*[]FederatedUser, bool)` + +GetUserConflictsOk returns a tuple with the UserConflicts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserConflicts + +`func (o *ConnectedOrgConfig) SetUserConflicts(v []FederatedUser)` + +SetUserConflicts sets UserConflicts field to given value. + +### HasUserConflicts + +`func (o *ConnectedOrgConfig) HasUserConflicts() bool` + +HasUserConflicts returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ContainerPeer.md b/docs/docs/ContainerPeer.md new file mode 100644 index 00000000..51d8b065 --- /dev/null +++ b/docs/docs/ContainerPeer.md @@ -0,0 +1,103 @@ +# ContainerPeer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering connection. | [optional] + +## Methods + +### NewContainerPeer + +`func NewContainerPeer(containerId string, ) *ContainerPeer` + +NewContainerPeer instantiates a new ContainerPeer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewContainerPeerWithDefaults + +`func NewContainerPeerWithDefaults() *ContainerPeer` + +NewContainerPeerWithDefaults instantiates a new ContainerPeer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContainerId + +`func (o *ContainerPeer) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *ContainerPeer) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *ContainerPeer) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetId + +`func (o *ContainerPeer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ContainerPeer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ContainerPeer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ContainerPeer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ContainerPeer) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ContainerPeer) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ContainerPeer) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *ContainerPeer) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ContainerPeerViewRequest.md b/docs/docs/ContainerPeerViewRequest.md new file mode 100644 index 00000000..23ef67f8 --- /dev/null +++ b/docs/docs/ContainerPeerViewRequest.md @@ -0,0 +1,464 @@ +# ContainerPeerViewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ProviderName** | **string** | Cloud service provider that serves the requested network peering connection. | +**AccepterRegionName** | **string** | Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region. | +**AwsAccountId** | **string** | Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. | +**ConnectionId** | Pointer to **string** | Unique string that identifies the peering connection on AWS. | [optional] [readonly] +**ErrorStateName** | Pointer to **string** | Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**RouteTableCidrBlock** | **string** | Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. | +**StatusName** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VpcId** | **string** | Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. | +**AzureDirectoryId** | **string** | Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides. | +**AzureSubscriptionId** | **string** | Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides. | +**ErrorState** | Pointer to **string** | Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded. | [optional] [readonly] +**ResourceGroupName** | **string** | Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides. | +**Status** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VnetName** | **string** | Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet. | +**ErrorMessage** | Pointer to **string** | Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**GcpProjectId** | **string** | Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC. | +**NetworkName** | **string** | Human-readable label that identifies the network to peer with the MongoDB Cloud VPC. | + +## Methods + +### NewContainerPeerViewRequest + +`func NewContainerPeerViewRequest(containerId string, providerName string, accepterRegionName string, awsAccountId string, routeTableCidrBlock string, vpcId string, azureDirectoryId string, azureSubscriptionId string, resourceGroupName string, vnetName string, gcpProjectId string, networkName string, ) *ContainerPeerViewRequest` + +NewContainerPeerViewRequest instantiates a new ContainerPeerViewRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewContainerPeerViewRequestWithDefaults + +`func NewContainerPeerViewRequestWithDefaults() *ContainerPeerViewRequest` + +NewContainerPeerViewRequestWithDefaults instantiates a new ContainerPeerViewRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContainerId + +`func (o *ContainerPeerViewRequest) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *ContainerPeerViewRequest) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *ContainerPeerViewRequest) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetProviderName + +`func (o *ContainerPeerViewRequest) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ContainerPeerViewRequest) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ContainerPeerViewRequest) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetAccepterRegionName + +`func (o *ContainerPeerViewRequest) GetAccepterRegionName() string` + +GetAccepterRegionName returns the AccepterRegionName field if non-nil, zero value otherwise. + +### GetAccepterRegionNameOk + +`func (o *ContainerPeerViewRequest) GetAccepterRegionNameOk() (*string, bool)` + +GetAccepterRegionNameOk returns a tuple with the AccepterRegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccepterRegionName + +`func (o *ContainerPeerViewRequest) SetAccepterRegionName(v string)` + +SetAccepterRegionName sets AccepterRegionName field to given value. + + +### GetAwsAccountId + +`func (o *ContainerPeerViewRequest) GetAwsAccountId() string` + +GetAwsAccountId returns the AwsAccountId field if non-nil, zero value otherwise. + +### GetAwsAccountIdOk + +`func (o *ContainerPeerViewRequest) GetAwsAccountIdOk() (*string, bool)` + +GetAwsAccountIdOk returns a tuple with the AwsAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccountId + +`func (o *ContainerPeerViewRequest) SetAwsAccountId(v string)` + +SetAwsAccountId sets AwsAccountId field to given value. + + +### GetConnectionId + +`func (o *ContainerPeerViewRequest) GetConnectionId() string` + +GetConnectionId returns the ConnectionId field if non-nil, zero value otherwise. + +### GetConnectionIdOk + +`func (o *ContainerPeerViewRequest) GetConnectionIdOk() (*string, bool)` + +GetConnectionIdOk returns a tuple with the ConnectionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionId + +`func (o *ContainerPeerViewRequest) SetConnectionId(v string)` + +SetConnectionId sets ConnectionId field to given value. + +### HasConnectionId + +`func (o *ContainerPeerViewRequest) HasConnectionId() bool` + +HasConnectionId returns a boolean if a field has been set. + +### GetErrorStateName + +`func (o *ContainerPeerViewRequest) GetErrorStateName() string` + +GetErrorStateName returns the ErrorStateName field if non-nil, zero value otherwise. + +### GetErrorStateNameOk + +`func (o *ContainerPeerViewRequest) GetErrorStateNameOk() (*string, bool)` + +GetErrorStateNameOk returns a tuple with the ErrorStateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorStateName + +`func (o *ContainerPeerViewRequest) SetErrorStateName(v string)` + +SetErrorStateName sets ErrorStateName field to given value. + +### HasErrorStateName + +`func (o *ContainerPeerViewRequest) HasErrorStateName() bool` + +HasErrorStateName returns a boolean if a field has been set. + +### GetId + +`func (o *ContainerPeerViewRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ContainerPeerViewRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ContainerPeerViewRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ContainerPeerViewRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRouteTableCidrBlock + +`func (o *ContainerPeerViewRequest) GetRouteTableCidrBlock() string` + +GetRouteTableCidrBlock returns the RouteTableCidrBlock field if non-nil, zero value otherwise. + +### GetRouteTableCidrBlockOk + +`func (o *ContainerPeerViewRequest) GetRouteTableCidrBlockOk() (*string, bool)` + +GetRouteTableCidrBlockOk returns a tuple with the RouteTableCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRouteTableCidrBlock + +`func (o *ContainerPeerViewRequest) SetRouteTableCidrBlock(v string)` + +SetRouteTableCidrBlock sets RouteTableCidrBlock field to given value. + + +### GetStatusName + +`func (o *ContainerPeerViewRequest) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *ContainerPeerViewRequest) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *ContainerPeerViewRequest) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *ContainerPeerViewRequest) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetVpcId + +`func (o *ContainerPeerViewRequest) GetVpcId() string` + +GetVpcId returns the VpcId field if non-nil, zero value otherwise. + +### GetVpcIdOk + +`func (o *ContainerPeerViewRequest) GetVpcIdOk() (*string, bool)` + +GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVpcId + +`func (o *ContainerPeerViewRequest) SetVpcId(v string)` + +SetVpcId sets VpcId field to given value. + + +### GetAzureDirectoryId + +`func (o *ContainerPeerViewRequest) GetAzureDirectoryId() string` + +GetAzureDirectoryId returns the AzureDirectoryId field if non-nil, zero value otherwise. + +### GetAzureDirectoryIdOk + +`func (o *ContainerPeerViewRequest) GetAzureDirectoryIdOk() (*string, bool)` + +GetAzureDirectoryIdOk returns a tuple with the AzureDirectoryId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureDirectoryId + +`func (o *ContainerPeerViewRequest) SetAzureDirectoryId(v string)` + +SetAzureDirectoryId sets AzureDirectoryId field to given value. + + +### GetAzureSubscriptionId + +`func (o *ContainerPeerViewRequest) GetAzureSubscriptionId() string` + +GetAzureSubscriptionId returns the AzureSubscriptionId field if non-nil, zero value otherwise. + +### GetAzureSubscriptionIdOk + +`func (o *ContainerPeerViewRequest) GetAzureSubscriptionIdOk() (*string, bool)` + +GetAzureSubscriptionIdOk returns a tuple with the AzureSubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureSubscriptionId + +`func (o *ContainerPeerViewRequest) SetAzureSubscriptionId(v string)` + +SetAzureSubscriptionId sets AzureSubscriptionId field to given value. + + +### GetErrorState + +`func (o *ContainerPeerViewRequest) GetErrorState() string` + +GetErrorState returns the ErrorState field if non-nil, zero value otherwise. + +### GetErrorStateOk + +`func (o *ContainerPeerViewRequest) GetErrorStateOk() (*string, bool)` + +GetErrorStateOk returns a tuple with the ErrorState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorState + +`func (o *ContainerPeerViewRequest) SetErrorState(v string)` + +SetErrorState sets ErrorState field to given value. + +### HasErrorState + +`func (o *ContainerPeerViewRequest) HasErrorState() bool` + +HasErrorState returns a boolean if a field has been set. + +### GetResourceGroupName + +`func (o *ContainerPeerViewRequest) GetResourceGroupName() string` + +GetResourceGroupName returns the ResourceGroupName field if non-nil, zero value otherwise. + +### GetResourceGroupNameOk + +`func (o *ContainerPeerViewRequest) GetResourceGroupNameOk() (*string, bool)` + +GetResourceGroupNameOk returns a tuple with the ResourceGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceGroupName + +`func (o *ContainerPeerViewRequest) SetResourceGroupName(v string)` + +SetResourceGroupName sets ResourceGroupName field to given value. + + +### GetStatus + +`func (o *ContainerPeerViewRequest) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ContainerPeerViewRequest) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ContainerPeerViewRequest) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ContainerPeerViewRequest) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetVnetName + +`func (o *ContainerPeerViewRequest) GetVnetName() string` + +GetVnetName returns the VnetName field if non-nil, zero value otherwise. + +### GetVnetNameOk + +`func (o *ContainerPeerViewRequest) GetVnetNameOk() (*string, bool)` + +GetVnetNameOk returns a tuple with the VnetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVnetName + +`func (o *ContainerPeerViewRequest) SetVnetName(v string)` + +SetVnetName sets VnetName field to given value. + + +### GetErrorMessage + +`func (o *ContainerPeerViewRequest) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ContainerPeerViewRequest) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ContainerPeerViewRequest) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ContainerPeerViewRequest) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *ContainerPeerViewRequest) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *ContainerPeerViewRequest) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *ContainerPeerViewRequest) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + + +### GetNetworkName + +`func (o *ContainerPeerViewRequest) GetNetworkName() string` + +GetNetworkName returns the NetworkName field if non-nil, zero value otherwise. + +### GetNetworkNameOk + +`func (o *ContainerPeerViewRequest) GetNetworkNameOk() (*string, bool)` + +GetNetworkNameOk returns a tuple with the NetworkName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkName + +`func (o *ContainerPeerViewRequest) SetNetworkName(v string)` + +SetNetworkName sets NetworkName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold.md b/docs/docs/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold.md new file mode 100644 index 00000000..11b0c3cd --- /dev/null +++ b/docs/docs/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold.md @@ -0,0 +1,11 @@ +# CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold + +## Enum + + +* `CPS_SNAPSHOT_BEHIND` (value: `"CPS_SNAPSHOT_BEHIND"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CpsBackupThresholdAlertConfigViewForNdsGroup.md b/docs/docs/CpsBackupThresholdAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..24a686e5 --- /dev/null +++ b/docs/docs/CpsBackupThresholdAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# CpsBackupThresholdAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold**](CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**GreaterThanTimeThreshold**](GreaterThanTimeThreshold.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewCpsBackupThresholdAlertConfigViewForNdsGroup + +`func NewCpsBackupThresholdAlertConfigViewForNdsGroup(eventTypeName CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold, ) *CpsBackupThresholdAlertConfigViewForNdsGroup` + +NewCpsBackupThresholdAlertConfigViewForNdsGroup instantiates a new CpsBackupThresholdAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCpsBackupThresholdAlertConfigViewForNdsGroupWithDefaults + +`func NewCpsBackupThresholdAlertConfigViewForNdsGroupWithDefaults() *CpsBackupThresholdAlertConfigViewForNdsGroup` + +NewCpsBackupThresholdAlertConfigViewForNdsGroupWithDefaults instantiates a new CpsBackupThresholdAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetEventTypeName() CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetEventTypeName(v CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetThreshold() GreaterThanTimeThreshold` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetThresholdOk() (*GreaterThanTimeThreshold, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetThreshold(v GreaterThanTimeThreshold)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *CpsBackupThresholdAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateAWSEndpointRequest.md b/docs/docs/CreateAWSEndpointRequest.md new file mode 100644 index 00000000..e03d1498 --- /dev/null +++ b/docs/docs/CreateAWSEndpointRequest.md @@ -0,0 +1,56 @@ +# CreateAWSEndpointRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. | [optional] + +## Methods + +### NewCreateAWSEndpointRequest + +`func NewCreateAWSEndpointRequest() *CreateAWSEndpointRequest` + +NewCreateAWSEndpointRequest instantiates a new CreateAWSEndpointRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateAWSEndpointRequestWithDefaults + +`func NewCreateAWSEndpointRequestWithDefaults() *CreateAWSEndpointRequest` + +NewCreateAWSEndpointRequestWithDefaults instantiates a new CreateAWSEndpointRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *CreateAWSEndpointRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateAWSEndpointRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateAWSEndpointRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CreateAWSEndpointRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateAWSEndpointRequestAllOf.md b/docs/docs/CreateAWSEndpointRequestAllOf.md new file mode 100644 index 00000000..0c4e10ed --- /dev/null +++ b/docs/docs/CreateAWSEndpointRequestAllOf.md @@ -0,0 +1,56 @@ +# CreateAWSEndpointRequestAllOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. | [optional] + +## Methods + +### NewCreateAWSEndpointRequestAllOf + +`func NewCreateAWSEndpointRequestAllOf() *CreateAWSEndpointRequestAllOf` + +NewCreateAWSEndpointRequestAllOf instantiates a new CreateAWSEndpointRequestAllOf object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateAWSEndpointRequestAllOfWithDefaults + +`func NewCreateAWSEndpointRequestAllOfWithDefaults() *CreateAWSEndpointRequestAllOf` + +NewCreateAWSEndpointRequestAllOfWithDefaults instantiates a new CreateAWSEndpointRequestAllOf object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *CreateAWSEndpointRequestAllOf) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateAWSEndpointRequestAllOf) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateAWSEndpointRequestAllOf) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CreateAWSEndpointRequestAllOf) HasId() bool` + +HasId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateApiKey.md b/docs/docs/CreateApiKey.md new file mode 100644 index 00000000..015a37f9 --- /dev/null +++ b/docs/docs/CreateApiKey.md @@ -0,0 +1,82 @@ +# CreateApiKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Desc** | Pointer to **string** | Purpose or explanation provided when someone created this organization API key. | [optional] +**Roles** | Pointer to **[]string** | List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. | [optional] + +## Methods + +### NewCreateApiKey + +`func NewCreateApiKey() *CreateApiKey` + +NewCreateApiKey instantiates a new CreateApiKey object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateApiKeyWithDefaults + +`func NewCreateApiKeyWithDefaults() *CreateApiKey` + +NewCreateApiKeyWithDefaults instantiates a new CreateApiKey object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDesc + +`func (o *CreateApiKey) GetDesc() string` + +GetDesc returns the Desc field if non-nil, zero value otherwise. + +### GetDescOk + +`func (o *CreateApiKey) GetDescOk() (*string, bool)` + +GetDescOk returns a tuple with the Desc field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDesc + +`func (o *CreateApiKey) SetDesc(v string)` + +SetDesc sets Desc field to given value. + +### HasDesc + +`func (o *CreateApiKey) HasDesc() bool` + +HasDesc returns a boolean if a field has been set. + +### GetRoles + +`func (o *CreateApiKey) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *CreateApiKey) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *CreateApiKey) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *CreateApiKey) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateAzureEndpointRequest.md b/docs/docs/CreateAzureEndpointRequest.md new file mode 100644 index 00000000..c1218acb --- /dev/null +++ b/docs/docs/CreateAzureEndpointRequest.md @@ -0,0 +1,82 @@ +# CreateAzureEndpointRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. | [optional] +**PrivateEndpointIPAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] + +## Methods + +### NewCreateAzureEndpointRequest + +`func NewCreateAzureEndpointRequest() *CreateAzureEndpointRequest` + +NewCreateAzureEndpointRequest instantiates a new CreateAzureEndpointRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateAzureEndpointRequestWithDefaults + +`func NewCreateAzureEndpointRequestWithDefaults() *CreateAzureEndpointRequest` + +NewCreateAzureEndpointRequestWithDefaults instantiates a new CreateAzureEndpointRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *CreateAzureEndpointRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateAzureEndpointRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateAzureEndpointRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CreateAzureEndpointRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetPrivateEndpointIPAddress + +`func (o *CreateAzureEndpointRequest) GetPrivateEndpointIPAddress() string` + +GetPrivateEndpointIPAddress returns the PrivateEndpointIPAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIPAddressOk + +`func (o *CreateAzureEndpointRequest) GetPrivateEndpointIPAddressOk() (*string, bool)` + +GetPrivateEndpointIPAddressOk returns a tuple with the PrivateEndpointIPAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIPAddress + +`func (o *CreateAzureEndpointRequest) SetPrivateEndpointIPAddress(v string)` + +SetPrivateEndpointIPAddress sets PrivateEndpointIPAddress field to given value. + +### HasPrivateEndpointIPAddress + +`func (o *CreateAzureEndpointRequest) HasPrivateEndpointIPAddress() bool` + +HasPrivateEndpointIPAddress returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateAzureEndpointRequestAllOf.md b/docs/docs/CreateAzureEndpointRequestAllOf.md new file mode 100644 index 00000000..2100523f --- /dev/null +++ b/docs/docs/CreateAzureEndpointRequestAllOf.md @@ -0,0 +1,82 @@ +# CreateAzureEndpointRequestAllOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. | [optional] +**PrivateEndpointIPAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] + +## Methods + +### NewCreateAzureEndpointRequestAllOf + +`func NewCreateAzureEndpointRequestAllOf() *CreateAzureEndpointRequestAllOf` + +NewCreateAzureEndpointRequestAllOf instantiates a new CreateAzureEndpointRequestAllOf object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateAzureEndpointRequestAllOfWithDefaults + +`func NewCreateAzureEndpointRequestAllOfWithDefaults() *CreateAzureEndpointRequestAllOf` + +NewCreateAzureEndpointRequestAllOfWithDefaults instantiates a new CreateAzureEndpointRequestAllOf object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *CreateAzureEndpointRequestAllOf) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateAzureEndpointRequestAllOf) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateAzureEndpointRequestAllOf) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CreateAzureEndpointRequestAllOf) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetPrivateEndpointIPAddress + +`func (o *CreateAzureEndpointRequestAllOf) GetPrivateEndpointIPAddress() string` + +GetPrivateEndpointIPAddress returns the PrivateEndpointIPAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIPAddressOk + +`func (o *CreateAzureEndpointRequestAllOf) GetPrivateEndpointIPAddressOk() (*string, bool)` + +GetPrivateEndpointIPAddressOk returns a tuple with the PrivateEndpointIPAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIPAddress + +`func (o *CreateAzureEndpointRequestAllOf) SetPrivateEndpointIPAddress(v string)` + +SetPrivateEndpointIPAddress sets PrivateEndpointIPAddress field to given value. + +### HasPrivateEndpointIPAddress + +`func (o *CreateAzureEndpointRequestAllOf) HasPrivateEndpointIPAddress() bool` + +HasPrivateEndpointIPAddress returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateEndpointServiceRequest.md b/docs/docs/CreateEndpointServiceRequest.md new file mode 100644 index 00000000..0bfeb6d1 --- /dev/null +++ b/docs/docs/CreateEndpointServiceRequest.md @@ -0,0 +1,72 @@ +# CreateEndpointServiceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProviderName** | **string** | Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service. | +**Region** | **string** | Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). | + +## Methods + +### NewCreateEndpointServiceRequest + +`func NewCreateEndpointServiceRequest(providerName string, region string, ) *CreateEndpointServiceRequest` + +NewCreateEndpointServiceRequest instantiates a new CreateEndpointServiceRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateEndpointServiceRequestWithDefaults + +`func NewCreateEndpointServiceRequestWithDefaults() *CreateEndpointServiceRequest` + +NewCreateEndpointServiceRequestWithDefaults instantiates a new CreateEndpointServiceRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetProviderName + +`func (o *CreateEndpointServiceRequest) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *CreateEndpointServiceRequest) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *CreateEndpointServiceRequest) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetRegion + +`func (o *CreateEndpointServiceRequest) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *CreateEndpointServiceRequest) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *CreateEndpointServiceRequest) SetRegion(v string)` + +SetRegion sets Region field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateGCPEndpointGroupRequest.md b/docs/docs/CreateGCPEndpointGroupRequest.md new file mode 100644 index 00000000..f17f64e0 --- /dev/null +++ b/docs/docs/CreateGCPEndpointGroupRequest.md @@ -0,0 +1,108 @@ +# CreateGCPEndpointGroupRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointGroupName** | Pointer to **string** | Human-readable label that identifies a set of endpoints. | [optional] +**Endpoints** | Pointer to [**[]CreateGCPForwardingRuleRequest**](CreateGCPForwardingRuleRequest.md) | List of individual private endpoints that comprise this endpoint group. | [optional] +**GcpProjectId** | Pointer to **string** | Unique string that identifies the Google Cloud project in which you created the endpoints. | [optional] + +## Methods + +### NewCreateGCPEndpointGroupRequest + +`func NewCreateGCPEndpointGroupRequest() *CreateGCPEndpointGroupRequest` + +NewCreateGCPEndpointGroupRequest instantiates a new CreateGCPEndpointGroupRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateGCPEndpointGroupRequestWithDefaults + +`func NewCreateGCPEndpointGroupRequestWithDefaults() *CreateGCPEndpointGroupRequest` + +NewCreateGCPEndpointGroupRequestWithDefaults instantiates a new CreateGCPEndpointGroupRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointGroupName + +`func (o *CreateGCPEndpointGroupRequest) GetEndpointGroupName() string` + +GetEndpointGroupName returns the EndpointGroupName field if non-nil, zero value otherwise. + +### GetEndpointGroupNameOk + +`func (o *CreateGCPEndpointGroupRequest) GetEndpointGroupNameOk() (*string, bool)` + +GetEndpointGroupNameOk returns a tuple with the EndpointGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointGroupName + +`func (o *CreateGCPEndpointGroupRequest) SetEndpointGroupName(v string)` + +SetEndpointGroupName sets EndpointGroupName field to given value. + +### HasEndpointGroupName + +`func (o *CreateGCPEndpointGroupRequest) HasEndpointGroupName() bool` + +HasEndpointGroupName returns a boolean if a field has been set. + +### GetEndpoints + +`func (o *CreateGCPEndpointGroupRequest) GetEndpoints() []CreateGCPForwardingRuleRequest` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *CreateGCPEndpointGroupRequest) GetEndpointsOk() (*[]CreateGCPForwardingRuleRequest, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpoints + +`func (o *CreateGCPEndpointGroupRequest) SetEndpoints(v []CreateGCPForwardingRuleRequest)` + +SetEndpoints sets Endpoints field to given value. + +### HasEndpoints + +`func (o *CreateGCPEndpointGroupRequest) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *CreateGCPEndpointGroupRequest) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *CreateGCPEndpointGroupRequest) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *CreateGCPEndpointGroupRequest) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + +### HasGcpProjectId + +`func (o *CreateGCPEndpointGroupRequest) HasGcpProjectId() bool` + +HasGcpProjectId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateGCPEndpointGroupRequestAllOf.md b/docs/docs/CreateGCPEndpointGroupRequestAllOf.md new file mode 100644 index 00000000..a393cc64 --- /dev/null +++ b/docs/docs/CreateGCPEndpointGroupRequestAllOf.md @@ -0,0 +1,108 @@ +# CreateGCPEndpointGroupRequestAllOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointGroupName** | Pointer to **string** | Human-readable label that identifies a set of endpoints. | [optional] +**Endpoints** | Pointer to [**[]CreateGCPForwardingRuleRequest**](CreateGCPForwardingRuleRequest.md) | List of individual private endpoints that comprise this endpoint group. | [optional] +**GcpProjectId** | Pointer to **string** | Unique string that identifies the Google Cloud project in which you created the endpoints. | [optional] + +## Methods + +### NewCreateGCPEndpointGroupRequestAllOf + +`func NewCreateGCPEndpointGroupRequestAllOf() *CreateGCPEndpointGroupRequestAllOf` + +NewCreateGCPEndpointGroupRequestAllOf instantiates a new CreateGCPEndpointGroupRequestAllOf object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateGCPEndpointGroupRequestAllOfWithDefaults + +`func NewCreateGCPEndpointGroupRequestAllOfWithDefaults() *CreateGCPEndpointGroupRequestAllOf` + +NewCreateGCPEndpointGroupRequestAllOfWithDefaults instantiates a new CreateGCPEndpointGroupRequestAllOf object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointGroupName + +`func (o *CreateGCPEndpointGroupRequestAllOf) GetEndpointGroupName() string` + +GetEndpointGroupName returns the EndpointGroupName field if non-nil, zero value otherwise. + +### GetEndpointGroupNameOk + +`func (o *CreateGCPEndpointGroupRequestAllOf) GetEndpointGroupNameOk() (*string, bool)` + +GetEndpointGroupNameOk returns a tuple with the EndpointGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointGroupName + +`func (o *CreateGCPEndpointGroupRequestAllOf) SetEndpointGroupName(v string)` + +SetEndpointGroupName sets EndpointGroupName field to given value. + +### HasEndpointGroupName + +`func (o *CreateGCPEndpointGroupRequestAllOf) HasEndpointGroupName() bool` + +HasEndpointGroupName returns a boolean if a field has been set. + +### GetEndpoints + +`func (o *CreateGCPEndpointGroupRequestAllOf) GetEndpoints() []CreateGCPForwardingRuleRequest` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *CreateGCPEndpointGroupRequestAllOf) GetEndpointsOk() (*[]CreateGCPForwardingRuleRequest, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpoints + +`func (o *CreateGCPEndpointGroupRequestAllOf) SetEndpoints(v []CreateGCPForwardingRuleRequest)` + +SetEndpoints sets Endpoints field to given value. + +### HasEndpoints + +`func (o *CreateGCPEndpointGroupRequestAllOf) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *CreateGCPEndpointGroupRequestAllOf) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *CreateGCPEndpointGroupRequestAllOf) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *CreateGCPEndpointGroupRequestAllOf) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + +### HasGcpProjectId + +`func (o *CreateGCPEndpointGroupRequestAllOf) HasGcpProjectId() bool` + +HasGcpProjectId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateGCPForwardingRuleRequest.md b/docs/docs/CreateGCPForwardingRuleRequest.md new file mode 100644 index 00000000..827679ca --- /dev/null +++ b/docs/docs/CreateGCPForwardingRuleRequest.md @@ -0,0 +1,82 @@ +# CreateGCPForwardingRuleRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointName** | Pointer to **string** | Human-readable label that identifies the Google Cloud consumer forwarding rule that you created. | [optional] +**IpAddress** | Pointer to **string** | One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves. | [optional] + +## Methods + +### NewCreateGCPForwardingRuleRequest + +`func NewCreateGCPForwardingRuleRequest() *CreateGCPForwardingRuleRequest` + +NewCreateGCPForwardingRuleRequest instantiates a new CreateGCPForwardingRuleRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateGCPForwardingRuleRequestWithDefaults + +`func NewCreateGCPForwardingRuleRequestWithDefaults() *CreateGCPForwardingRuleRequest` + +NewCreateGCPForwardingRuleRequestWithDefaults instantiates a new CreateGCPForwardingRuleRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointName + +`func (o *CreateGCPForwardingRuleRequest) GetEndpointName() string` + +GetEndpointName returns the EndpointName field if non-nil, zero value otherwise. + +### GetEndpointNameOk + +`func (o *CreateGCPForwardingRuleRequest) GetEndpointNameOk() (*string, bool)` + +GetEndpointNameOk returns a tuple with the EndpointName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointName + +`func (o *CreateGCPForwardingRuleRequest) SetEndpointName(v string)` + +SetEndpointName sets EndpointName field to given value. + +### HasEndpointName + +`func (o *CreateGCPForwardingRuleRequest) HasEndpointName() bool` + +HasEndpointName returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *CreateGCPForwardingRuleRequest) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *CreateGCPForwardingRuleRequest) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *CreateGCPForwardingRuleRequest) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *CreateGCPForwardingRuleRequest) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateOrganizationRequest.md b/docs/docs/CreateOrganizationRequest.md new file mode 100644 index 00000000..aae822e7 --- /dev/null +++ b/docs/docs/CreateOrganizationRequest.md @@ -0,0 +1,103 @@ +# CreateOrganizationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | Pointer to [**CreateApiKey**](CreateApiKey.md) | | [optional] +**Name** | **string** | Human-readable label that identifies the organization. | +**OrgOwnerId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. This is required if you call the Admin API endpoint directly, but not required when you call through the Atlas CLI. | [optional] + +## Methods + +### NewCreateOrganizationRequest + +`func NewCreateOrganizationRequest(name string, ) *CreateOrganizationRequest` + +NewCreateOrganizationRequest instantiates a new CreateOrganizationRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateOrganizationRequestWithDefaults + +`func NewCreateOrganizationRequestWithDefaults() *CreateOrganizationRequest` + +NewCreateOrganizationRequestWithDefaults instantiates a new CreateOrganizationRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKey + +`func (o *CreateOrganizationRequest) GetApiKey() CreateApiKey` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *CreateOrganizationRequest) GetApiKeyOk() (*CreateApiKey, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *CreateOrganizationRequest) SetApiKey(v CreateApiKey)` + +SetApiKey sets ApiKey field to given value. + +### HasApiKey + +`func (o *CreateOrganizationRequest) HasApiKey() bool` + +HasApiKey returns a boolean if a field has been set. + +### GetName + +`func (o *CreateOrganizationRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOrganizationRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOrganizationRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOrgOwnerId + +`func (o *CreateOrganizationRequest) GetOrgOwnerId() string` + +GetOrgOwnerId returns the OrgOwnerId field if non-nil, zero value otherwise. + +### GetOrgOwnerIdOk + +`func (o *CreateOrganizationRequest) GetOrgOwnerIdOk() (*string, bool)` + +GetOrgOwnerIdOk returns a tuple with the OrgOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgOwnerId + +`func (o *CreateOrganizationRequest) SetOrgOwnerId(v string)` + +SetOrgOwnerId sets OrgOwnerId field to given value. + +### HasOrgOwnerId + +`func (o *CreateOrganizationRequest) HasOrgOwnerId() bool` + +HasOrgOwnerId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreateOrganizationResponse.md b/docs/docs/CreateOrganizationResponse.md new file mode 100644 index 00000000..1d7ac5c4 --- /dev/null +++ b/docs/docs/CreateOrganizationResponse.md @@ -0,0 +1,108 @@ +# CreateOrganizationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | Pointer to [**ApiUser**](ApiUser.md) | | [optional] +**OrgOwnerId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Atlas user that you want to assign the Organization Owner role. | [optional] [readonly] +**Organization** | Pointer to [**Organization**](Organization.md) | | [optional] + +## Methods + +### NewCreateOrganizationResponse + +`func NewCreateOrganizationResponse() *CreateOrganizationResponse` + +NewCreateOrganizationResponse instantiates a new CreateOrganizationResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateOrganizationResponseWithDefaults + +`func NewCreateOrganizationResponseWithDefaults() *CreateOrganizationResponse` + +NewCreateOrganizationResponseWithDefaults instantiates a new CreateOrganizationResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKey + +`func (o *CreateOrganizationResponse) GetApiKey() ApiUser` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *CreateOrganizationResponse) GetApiKeyOk() (*ApiUser, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *CreateOrganizationResponse) SetApiKey(v ApiUser)` + +SetApiKey sets ApiKey field to given value. + +### HasApiKey + +`func (o *CreateOrganizationResponse) HasApiKey() bool` + +HasApiKey returns a boolean if a field has been set. + +### GetOrgOwnerId + +`func (o *CreateOrganizationResponse) GetOrgOwnerId() string` + +GetOrgOwnerId returns the OrgOwnerId field if non-nil, zero value otherwise. + +### GetOrgOwnerIdOk + +`func (o *CreateOrganizationResponse) GetOrgOwnerIdOk() (*string, bool)` + +GetOrgOwnerIdOk returns a tuple with the OrgOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgOwnerId + +`func (o *CreateOrganizationResponse) SetOrgOwnerId(v string)` + +SetOrgOwnerId sets OrgOwnerId field to given value. + +### HasOrgOwnerId + +`func (o *CreateOrganizationResponse) HasOrgOwnerId() bool` + +HasOrgOwnerId returns a boolean if a field has been set. + +### GetOrganization + +`func (o *CreateOrganizationResponse) GetOrganization() Organization` + +GetOrganization returns the Organization field if non-nil, zero value otherwise. + +### GetOrganizationOk + +`func (o *CreateOrganizationResponse) GetOrganizationOk() (*Organization, bool)` + +GetOrganizationOk returns a tuple with the Organization field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrganization + +`func (o *CreateOrganizationResponse) SetOrganization(v Organization)` + +SetOrganization sets Organization field to given value. + +### HasOrganization + +`func (o *CreateOrganizationResponse) HasOrganization() bool` + +HasOrganization returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreatePeeringConnection200Response.md b/docs/docs/CreatePeeringConnection200Response.md new file mode 100644 index 00000000..09c2f637 --- /dev/null +++ b/docs/docs/CreatePeeringConnection200Response.md @@ -0,0 +1,469 @@ +# CreatePeeringConnection200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccepterRegionName** | **string** | Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region. | +**AwsAccountId** | **string** | Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. | +**ConnectionId** | Pointer to **string** | Unique string that identifies the peering connection on AWS. | [optional] [readonly] +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ErrorStateName** | Pointer to **string** | Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering connection. | [optional] +**RouteTableCidrBlock** | **string** | Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. | +**StatusName** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VpcId** | **string** | Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. | +**AzureDirectoryId** | **string** | Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides. | +**AzureSubscriptionId** | **string** | Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides. | +**ErrorState** | Pointer to **string** | Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded. | [optional] [readonly] +**ResourceGroupName** | **string** | Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides. | +**Status** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VnetName** | **string** | Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet. | +**ErrorMessage** | Pointer to **string** | Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**GcpProjectId** | **string** | Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC. | +**NetworkName** | **string** | Human-readable label that identifies the network to peer with the MongoDB Cloud VPC. | + +## Methods + +### NewCreatePeeringConnection200Response + +`func NewCreatePeeringConnection200Response(accepterRegionName string, awsAccountId string, containerId string, routeTableCidrBlock string, vpcId string, azureDirectoryId string, azureSubscriptionId string, resourceGroupName string, vnetName string, gcpProjectId string, networkName string, ) *CreatePeeringConnection200Response` + +NewCreatePeeringConnection200Response instantiates a new CreatePeeringConnection200Response object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreatePeeringConnection200ResponseWithDefaults + +`func NewCreatePeeringConnection200ResponseWithDefaults() *CreatePeeringConnection200Response` + +NewCreatePeeringConnection200ResponseWithDefaults instantiates a new CreatePeeringConnection200Response object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccepterRegionName + +`func (o *CreatePeeringConnection200Response) GetAccepterRegionName() string` + +GetAccepterRegionName returns the AccepterRegionName field if non-nil, zero value otherwise. + +### GetAccepterRegionNameOk + +`func (o *CreatePeeringConnection200Response) GetAccepterRegionNameOk() (*string, bool)` + +GetAccepterRegionNameOk returns a tuple with the AccepterRegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccepterRegionName + +`func (o *CreatePeeringConnection200Response) SetAccepterRegionName(v string)` + +SetAccepterRegionName sets AccepterRegionName field to given value. + + +### GetAwsAccountId + +`func (o *CreatePeeringConnection200Response) GetAwsAccountId() string` + +GetAwsAccountId returns the AwsAccountId field if non-nil, zero value otherwise. + +### GetAwsAccountIdOk + +`func (o *CreatePeeringConnection200Response) GetAwsAccountIdOk() (*string, bool)` + +GetAwsAccountIdOk returns a tuple with the AwsAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccountId + +`func (o *CreatePeeringConnection200Response) SetAwsAccountId(v string)` + +SetAwsAccountId sets AwsAccountId field to given value. + + +### GetConnectionId + +`func (o *CreatePeeringConnection200Response) GetConnectionId() string` + +GetConnectionId returns the ConnectionId field if non-nil, zero value otherwise. + +### GetConnectionIdOk + +`func (o *CreatePeeringConnection200Response) GetConnectionIdOk() (*string, bool)` + +GetConnectionIdOk returns a tuple with the ConnectionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionId + +`func (o *CreatePeeringConnection200Response) SetConnectionId(v string)` + +SetConnectionId sets ConnectionId field to given value. + +### HasConnectionId + +`func (o *CreatePeeringConnection200Response) HasConnectionId() bool` + +HasConnectionId returns a boolean if a field has been set. + +### GetContainerId + +`func (o *CreatePeeringConnection200Response) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *CreatePeeringConnection200Response) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *CreatePeeringConnection200Response) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetErrorStateName + +`func (o *CreatePeeringConnection200Response) GetErrorStateName() string` + +GetErrorStateName returns the ErrorStateName field if non-nil, zero value otherwise. + +### GetErrorStateNameOk + +`func (o *CreatePeeringConnection200Response) GetErrorStateNameOk() (*string, bool)` + +GetErrorStateNameOk returns a tuple with the ErrorStateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorStateName + +`func (o *CreatePeeringConnection200Response) SetErrorStateName(v string)` + +SetErrorStateName sets ErrorStateName field to given value. + +### HasErrorStateName + +`func (o *CreatePeeringConnection200Response) HasErrorStateName() bool` + +HasErrorStateName returns a boolean if a field has been set. + +### GetId + +`func (o *CreatePeeringConnection200Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreatePeeringConnection200Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreatePeeringConnection200Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CreatePeeringConnection200Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *CreatePeeringConnection200Response) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *CreatePeeringConnection200Response) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *CreatePeeringConnection200Response) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *CreatePeeringConnection200Response) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRouteTableCidrBlock + +`func (o *CreatePeeringConnection200Response) GetRouteTableCidrBlock() string` + +GetRouteTableCidrBlock returns the RouteTableCidrBlock field if non-nil, zero value otherwise. + +### GetRouteTableCidrBlockOk + +`func (o *CreatePeeringConnection200Response) GetRouteTableCidrBlockOk() (*string, bool)` + +GetRouteTableCidrBlockOk returns a tuple with the RouteTableCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRouteTableCidrBlock + +`func (o *CreatePeeringConnection200Response) SetRouteTableCidrBlock(v string)` + +SetRouteTableCidrBlock sets RouteTableCidrBlock field to given value. + + +### GetStatusName + +`func (o *CreatePeeringConnection200Response) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *CreatePeeringConnection200Response) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *CreatePeeringConnection200Response) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *CreatePeeringConnection200Response) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetVpcId + +`func (o *CreatePeeringConnection200Response) GetVpcId() string` + +GetVpcId returns the VpcId field if non-nil, zero value otherwise. + +### GetVpcIdOk + +`func (o *CreatePeeringConnection200Response) GetVpcIdOk() (*string, bool)` + +GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVpcId + +`func (o *CreatePeeringConnection200Response) SetVpcId(v string)` + +SetVpcId sets VpcId field to given value. + + +### GetAzureDirectoryId + +`func (o *CreatePeeringConnection200Response) GetAzureDirectoryId() string` + +GetAzureDirectoryId returns the AzureDirectoryId field if non-nil, zero value otherwise. + +### GetAzureDirectoryIdOk + +`func (o *CreatePeeringConnection200Response) GetAzureDirectoryIdOk() (*string, bool)` + +GetAzureDirectoryIdOk returns a tuple with the AzureDirectoryId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureDirectoryId + +`func (o *CreatePeeringConnection200Response) SetAzureDirectoryId(v string)` + +SetAzureDirectoryId sets AzureDirectoryId field to given value. + + +### GetAzureSubscriptionId + +`func (o *CreatePeeringConnection200Response) GetAzureSubscriptionId() string` + +GetAzureSubscriptionId returns the AzureSubscriptionId field if non-nil, zero value otherwise. + +### GetAzureSubscriptionIdOk + +`func (o *CreatePeeringConnection200Response) GetAzureSubscriptionIdOk() (*string, bool)` + +GetAzureSubscriptionIdOk returns a tuple with the AzureSubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureSubscriptionId + +`func (o *CreatePeeringConnection200Response) SetAzureSubscriptionId(v string)` + +SetAzureSubscriptionId sets AzureSubscriptionId field to given value. + + +### GetErrorState + +`func (o *CreatePeeringConnection200Response) GetErrorState() string` + +GetErrorState returns the ErrorState field if non-nil, zero value otherwise. + +### GetErrorStateOk + +`func (o *CreatePeeringConnection200Response) GetErrorStateOk() (*string, bool)` + +GetErrorStateOk returns a tuple with the ErrorState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorState + +`func (o *CreatePeeringConnection200Response) SetErrorState(v string)` + +SetErrorState sets ErrorState field to given value. + +### HasErrorState + +`func (o *CreatePeeringConnection200Response) HasErrorState() bool` + +HasErrorState returns a boolean if a field has been set. + +### GetResourceGroupName + +`func (o *CreatePeeringConnection200Response) GetResourceGroupName() string` + +GetResourceGroupName returns the ResourceGroupName field if non-nil, zero value otherwise. + +### GetResourceGroupNameOk + +`func (o *CreatePeeringConnection200Response) GetResourceGroupNameOk() (*string, bool)` + +GetResourceGroupNameOk returns a tuple with the ResourceGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceGroupName + +`func (o *CreatePeeringConnection200Response) SetResourceGroupName(v string)` + +SetResourceGroupName sets ResourceGroupName field to given value. + + +### GetStatus + +`func (o *CreatePeeringConnection200Response) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CreatePeeringConnection200Response) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CreatePeeringConnection200Response) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CreatePeeringConnection200Response) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetVnetName + +`func (o *CreatePeeringConnection200Response) GetVnetName() string` + +GetVnetName returns the VnetName field if non-nil, zero value otherwise. + +### GetVnetNameOk + +`func (o *CreatePeeringConnection200Response) GetVnetNameOk() (*string, bool)` + +GetVnetNameOk returns a tuple with the VnetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVnetName + +`func (o *CreatePeeringConnection200Response) SetVnetName(v string)` + +SetVnetName sets VnetName field to given value. + + +### GetErrorMessage + +`func (o *CreatePeeringConnection200Response) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CreatePeeringConnection200Response) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CreatePeeringConnection200Response) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CreatePeeringConnection200Response) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *CreatePeeringConnection200Response) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *CreatePeeringConnection200Response) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *CreatePeeringConnection200Response) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + + +### GetNetworkName + +`func (o *CreatePeeringConnection200Response) GetNetworkName() string` + +GetNetworkName returns the NetworkName field if non-nil, zero value otherwise. + +### GetNetworkNameOk + +`func (o *CreatePeeringConnection200Response) GetNetworkNameOk() (*string, bool)` + +GetNetworkNameOk returns a tuple with the NetworkName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkName + +`func (o *CreatePeeringConnection200Response) SetNetworkName(v string)` + +SetNetworkName sets NetworkName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CreatePrivateEndpointRequest.md b/docs/docs/CreatePrivateEndpointRequest.md new file mode 100644 index 00000000..6df5ebd5 --- /dev/null +++ b/docs/docs/CreatePrivateEndpointRequest.md @@ -0,0 +1,160 @@ +# CreatePrivateEndpointRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. | [optional] +**PrivateEndpointIPAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] +**EndpointGroupName** | Pointer to **string** | Human-readable label that identifies a set of endpoints. | [optional] +**Endpoints** | Pointer to [**[]CreateGCPForwardingRuleRequest**](CreateGCPForwardingRuleRequest.md) | List of individual private endpoints that comprise this endpoint group. | [optional] +**GcpProjectId** | Pointer to **string** | Unique string that identifies the Google Cloud project in which you created the endpoints. | [optional] + +## Methods + +### NewCreatePrivateEndpointRequest + +`func NewCreatePrivateEndpointRequest() *CreatePrivateEndpointRequest` + +NewCreatePrivateEndpointRequest instantiates a new CreatePrivateEndpointRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreatePrivateEndpointRequestWithDefaults + +`func NewCreatePrivateEndpointRequestWithDefaults() *CreatePrivateEndpointRequest` + +NewCreatePrivateEndpointRequestWithDefaults instantiates a new CreatePrivateEndpointRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *CreatePrivateEndpointRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreatePrivateEndpointRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreatePrivateEndpointRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CreatePrivateEndpointRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetPrivateEndpointIPAddress + +`func (o *CreatePrivateEndpointRequest) GetPrivateEndpointIPAddress() string` + +GetPrivateEndpointIPAddress returns the PrivateEndpointIPAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIPAddressOk + +`func (o *CreatePrivateEndpointRequest) GetPrivateEndpointIPAddressOk() (*string, bool)` + +GetPrivateEndpointIPAddressOk returns a tuple with the PrivateEndpointIPAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIPAddress + +`func (o *CreatePrivateEndpointRequest) SetPrivateEndpointIPAddress(v string)` + +SetPrivateEndpointIPAddress sets PrivateEndpointIPAddress field to given value. + +### HasPrivateEndpointIPAddress + +`func (o *CreatePrivateEndpointRequest) HasPrivateEndpointIPAddress() bool` + +HasPrivateEndpointIPAddress returns a boolean if a field has been set. + +### GetEndpointGroupName + +`func (o *CreatePrivateEndpointRequest) GetEndpointGroupName() string` + +GetEndpointGroupName returns the EndpointGroupName field if non-nil, zero value otherwise. + +### GetEndpointGroupNameOk + +`func (o *CreatePrivateEndpointRequest) GetEndpointGroupNameOk() (*string, bool)` + +GetEndpointGroupNameOk returns a tuple with the EndpointGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointGroupName + +`func (o *CreatePrivateEndpointRequest) SetEndpointGroupName(v string)` + +SetEndpointGroupName sets EndpointGroupName field to given value. + +### HasEndpointGroupName + +`func (o *CreatePrivateEndpointRequest) HasEndpointGroupName() bool` + +HasEndpointGroupName returns a boolean if a field has been set. + +### GetEndpoints + +`func (o *CreatePrivateEndpointRequest) GetEndpoints() []CreateGCPForwardingRuleRequest` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *CreatePrivateEndpointRequest) GetEndpointsOk() (*[]CreateGCPForwardingRuleRequest, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpoints + +`func (o *CreatePrivateEndpointRequest) SetEndpoints(v []CreateGCPForwardingRuleRequest)` + +SetEndpoints sets Endpoints field to given value. + +### HasEndpoints + +`func (o *CreatePrivateEndpointRequest) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *CreatePrivateEndpointRequest) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *CreatePrivateEndpointRequest) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *CreatePrivateEndpointRequest) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + +### HasGcpProjectId + +`func (o *CreatePrivateEndpointRequest) HasGcpProjectId() bool` + +HasGcpProjectId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Criteria.md b/docs/docs/Criteria.md new file mode 100644 index 00000000..eb456b8b --- /dev/null +++ b/docs/docs/Criteria.md @@ -0,0 +1,155 @@ +# Criteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**. | +**Type** | Pointer to **string** | Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query. **DATE** selects documents to archive based on a date. **CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`. | [optional] +**DateField** | Pointer to **string** | Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`. | [optional] +**DateFormat** | Pointer to **string** | Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**. You must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**. | [optional] [default to "ISODATE"] +**ExpireAfterDays** | Pointer to **int** | Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**. | [optional] + +## Methods + +### NewCriteria + +`func NewCriteria(query string, ) *Criteria` + +NewCriteria instantiates a new Criteria object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCriteriaWithDefaults + +`func NewCriteriaWithDefaults() *Criteria` + +NewCriteriaWithDefaults instantiates a new Criteria object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetQuery + +`func (o *Criteria) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *Criteria) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *Criteria) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetType + +`func (o *Criteria) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Criteria) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Criteria) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Criteria) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDateField + +`func (o *Criteria) GetDateField() string` + +GetDateField returns the DateField field if non-nil, zero value otherwise. + +### GetDateFieldOk + +`func (o *Criteria) GetDateFieldOk() (*string, bool)` + +GetDateFieldOk returns a tuple with the DateField field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateField + +`func (o *Criteria) SetDateField(v string)` + +SetDateField sets DateField field to given value. + +### HasDateField + +`func (o *Criteria) HasDateField() bool` + +HasDateField returns a boolean if a field has been set. + +### GetDateFormat + +`func (o *Criteria) GetDateFormat() string` + +GetDateFormat returns the DateFormat field if non-nil, zero value otherwise. + +### GetDateFormatOk + +`func (o *Criteria) GetDateFormatOk() (*string, bool)` + +GetDateFormatOk returns a tuple with the DateFormat field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateFormat + +`func (o *Criteria) SetDateFormat(v string)` + +SetDateFormat sets DateFormat field to given value. + +### HasDateFormat + +`func (o *Criteria) HasDateFormat() bool` + +HasDateFormat returns a boolean if a field has been set. + +### GetExpireAfterDays + +`func (o *Criteria) GetExpireAfterDays() int` + +GetExpireAfterDays returns the ExpireAfterDays field if non-nil, zero value otherwise. + +### GetExpireAfterDaysOk + +`func (o *Criteria) GetExpireAfterDaysOk() (*int, bool)` + +GetExpireAfterDaysOk returns a tuple with the ExpireAfterDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpireAfterDays + +`func (o *Criteria) SetExpireAfterDays(v int)` + +SetExpireAfterDays sets ExpireAfterDays field to given value. + +### HasExpireAfterDays + +`func (o *Criteria) HasExpireAfterDays() bool` + +HasExpireAfterDays returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CustomCriteria.md b/docs/docs/CustomCriteria.md new file mode 100644 index 00000000..2f85d0f5 --- /dev/null +++ b/docs/docs/CustomCriteria.md @@ -0,0 +1,77 @@ +# CustomCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**. | +**Type** | Pointer to **string** | Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query. **DATE** selects documents to archive based on a date. **CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`. | [optional] + +## Methods + +### NewCustomCriteria + +`func NewCustomCriteria(query string, ) *CustomCriteria` + +NewCustomCriteria instantiates a new CustomCriteria object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCustomCriteriaWithDefaults + +`func NewCustomCriteriaWithDefaults() *CustomCriteria` + +NewCustomCriteriaWithDefaults instantiates a new CustomCriteria object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetQuery + +`func (o *CustomCriteria) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CustomCriteria) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CustomCriteria) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetType + +`func (o *CustomCriteria) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CustomCriteria) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CustomCriteria) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CustomCriteria) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CustomDBRole.md b/docs/docs/CustomDBRole.md new file mode 100644 index 00000000..87b0a5e2 --- /dev/null +++ b/docs/docs/CustomDBRole.md @@ -0,0 +1,103 @@ +# CustomDBRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Actions** | Pointer to [**[]DBAction**](DBAction.md) | List of the individual privilege actions that the role grants. | [optional] +**InheritedRoles** | Pointer to [**[]InheritedRole**](InheritedRole.md) | List of the built-in roles that this custom role inherits. | [optional] +**RoleName** | **string** | Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. | + +## Methods + +### NewCustomDBRole + +`func NewCustomDBRole(roleName string, ) *CustomDBRole` + +NewCustomDBRole instantiates a new CustomDBRole object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCustomDBRoleWithDefaults + +`func NewCustomDBRoleWithDefaults() *CustomDBRole` + +NewCustomDBRoleWithDefaults instantiates a new CustomDBRole object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetActions + +`func (o *CustomDBRole) GetActions() []DBAction` + +GetActions returns the Actions field if non-nil, zero value otherwise. + +### GetActionsOk + +`func (o *CustomDBRole) GetActionsOk() (*[]DBAction, bool)` + +GetActionsOk returns a tuple with the Actions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActions + +`func (o *CustomDBRole) SetActions(v []DBAction)` + +SetActions sets Actions field to given value. + +### HasActions + +`func (o *CustomDBRole) HasActions() bool` + +HasActions returns a boolean if a field has been set. + +### GetInheritedRoles + +`func (o *CustomDBRole) GetInheritedRoles() []InheritedRole` + +GetInheritedRoles returns the InheritedRoles field if non-nil, zero value otherwise. + +### GetInheritedRolesOk + +`func (o *CustomDBRole) GetInheritedRolesOk() (*[]InheritedRole, bool)` + +GetInheritedRolesOk returns a tuple with the InheritedRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInheritedRoles + +`func (o *CustomDBRole) SetInheritedRoles(v []InheritedRole)` + +SetInheritedRoles sets InheritedRoles field to given value. + +### HasInheritedRoles + +`func (o *CustomDBRole) HasInheritedRoles() bool` + +HasInheritedRoles returns a boolean if a field has been set. + +### GetRoleName + +`func (o *CustomDBRole) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *CustomDBRole) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *CustomDBRole) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CustomDatabaseRolesApi.md b/docs/docs/CustomDatabaseRolesApi.md new file mode 100644 index 00000000..4020852e --- /dev/null +++ b/docs/docs/CustomDatabaseRolesApi.md @@ -0,0 +1,394 @@ +# \CustomDatabaseRolesApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateCustomDatabaseRole**](CustomDatabaseRolesApi.md#CreateCustomDatabaseRole) | **Post** /api/atlas/v2/groups/{groupId}/customDBRoles/roles | Create One Custom Role +[**DeleteCustomDatabaseRole**](CustomDatabaseRolesApi.md#DeleteCustomDatabaseRole) | **Delete** /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName} | Remove One Custom Role from One Project +[**GetCustomDatabaseRole**](CustomDatabaseRolesApi.md#GetCustomDatabaseRole) | **Get** /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName} | Return One Custom Role in One Project +[**ListCustomDatabaseRoles**](CustomDatabaseRolesApi.md#ListCustomDatabaseRoles) | **Get** /api/atlas/v2/groups/{groupId}/customDBRoles/roles | Return All Custom Roles in One Project +[**UpdateCustomDatabaseRole**](CustomDatabaseRolesApi.md#UpdateCustomDatabaseRole) | **Patch** /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName} | Update One Custom Role in One Project + + + +## CreateCustomDatabaseRole + +> CustomDBRole CreateCustomDatabaseRole(ctx, groupId).CustomDBRole(customDBRole).Execute() + +Create One Custom Role + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + customDBRole := *openapiclient.NewCustomDBRole("RoleName_example") // CustomDBRole | + + resp, r, err := sdk.CustomDatabaseRolesApi.CreateCustomDatabaseRole(context.Background(), groupId).CustomDBRole(customDBRole).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomDatabaseRolesApi.CreateCustomDatabaseRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateCustomDatabaseRole`: CustomDBRole + fmt.Fprintf(os.Stdout, "Response from `CustomDatabaseRolesApi.CreateCustomDatabaseRole`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomDatabaseRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **customDBRole** | [**CustomDBRole**](CustomDBRole.md) | Creates one custom role in the specified project. | + +### Return type + +[**CustomDBRole**](CustomDBRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteCustomDatabaseRole + +> DeleteCustomDatabaseRole(ctx, groupId, roleName).Execute() + +Remove One Custom Role from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + roleName := "roleName_example" // string | + + r, err := sdk.CustomDatabaseRolesApi.DeleteCustomDatabaseRole(context.Background(), groupId, roleName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomDatabaseRolesApi.DeleteCustomDatabaseRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**roleName** | **string** | Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCustomDatabaseRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetCustomDatabaseRole + +> CustomDBRole GetCustomDatabaseRole(ctx, groupId, roleName).Execute() + +Return One Custom Role in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + roleName := "roleName_example" // string | + + resp, r, err := sdk.CustomDatabaseRolesApi.GetCustomDatabaseRole(context.Background(), groupId, roleName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomDatabaseRolesApi.GetCustomDatabaseRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetCustomDatabaseRole`: CustomDBRole + fmt.Fprintf(os.Stdout, "Response from `CustomDatabaseRolesApi.GetCustomDatabaseRole`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**roleName** | **string** | Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomDatabaseRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**CustomDBRole**](CustomDBRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListCustomDatabaseRoles + +> []CustomDBRole ListCustomDatabaseRoles(ctx, groupId).Execute() + +Return All Custom Roles in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.CustomDatabaseRolesApi.ListCustomDatabaseRoles(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomDatabaseRolesApi.ListCustomDatabaseRoles``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListCustomDatabaseRoles`: []CustomDBRole + fmt.Fprintf(os.Stdout, "Response from `CustomDatabaseRolesApi.ListCustomDatabaseRoles`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCustomDatabaseRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]CustomDBRole**](CustomDBRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateCustomDatabaseRole + +> CustomDBRole UpdateCustomDatabaseRole(ctx, groupId, roleName).UpdateCustomDBRole(updateCustomDBRole).Execute() + +Update One Custom Role in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + roleName := "roleName_example" // string | + updateCustomDBRole := *openapiclient.NewUpdateCustomDBRole() // UpdateCustomDBRole | + + resp, r, err := sdk.CustomDatabaseRolesApi.UpdateCustomDatabaseRole(context.Background(), groupId, roleName).UpdateCustomDBRole(updateCustomDBRole).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomDatabaseRolesApi.UpdateCustomDatabaseRole``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateCustomDatabaseRole`: CustomDBRole + fmt.Fprintf(os.Stdout, "Response from `CustomDatabaseRolesApi.UpdateCustomDatabaseRole`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**roleName** | **string** | Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCustomDatabaseRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **updateCustomDBRole** | [**UpdateCustomDBRole**](UpdateCustomDBRole.md) | Updates one custom role in the specified project. | + +### Return type + +[**CustomDBRole**](CustomDBRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/CustomZoneMappings.md b/docs/docs/CustomZoneMappings.md new file mode 100644 index 00000000..c677383a --- /dev/null +++ b/docs/docs/CustomZoneMappings.md @@ -0,0 +1,56 @@ +# CustomZoneMappings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomZoneMappings** | Pointer to [**[]ZoneMapping**](ZoneMapping.md) | List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings. This parameter returns an empty object if no custom zones exist. | [optional] + +## Methods + +### NewCustomZoneMappings + +`func NewCustomZoneMappings() *CustomZoneMappings` + +NewCustomZoneMappings instantiates a new CustomZoneMappings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCustomZoneMappingsWithDefaults + +`func NewCustomZoneMappingsWithDefaults() *CustomZoneMappings` + +NewCustomZoneMappingsWithDefaults instantiates a new CustomZoneMappings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCustomZoneMappings + +`func (o *CustomZoneMappings) GetCustomZoneMappings() []ZoneMapping` + +GetCustomZoneMappings returns the CustomZoneMappings field if non-nil, zero value otherwise. + +### GetCustomZoneMappingsOk + +`func (o *CustomZoneMappings) GetCustomZoneMappingsOk() (*[]ZoneMapping, bool)` + +GetCustomZoneMappingsOk returns a tuple with the CustomZoneMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomZoneMappings + +`func (o *CustomZoneMappings) SetCustomZoneMappings(v []ZoneMapping)` + +SetCustomZoneMappings sets CustomZoneMappings field to given value. + +### HasCustomZoneMappings + +`func (o *CustomZoneMappings) HasCustomZoneMappings() bool` + +HasCustomZoneMappings returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/CustomerX509.md b/docs/docs/CustomerX509.md new file mode 100644 index 00000000..ae85456e --- /dev/null +++ b/docs/docs/CustomerX509.md @@ -0,0 +1,82 @@ +# CustomerX509 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Cas** | Pointer to **string** | Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewCustomerX509 + +`func NewCustomerX509() *CustomerX509` + +NewCustomerX509 instantiates a new CustomerX509 object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCustomerX509WithDefaults + +`func NewCustomerX509WithDefaults() *CustomerX509` + +NewCustomerX509WithDefaults instantiates a new CustomerX509 object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCas + +`func (o *CustomerX509) GetCas() string` + +GetCas returns the Cas field if non-nil, zero value otherwise. + +### GetCasOk + +`func (o *CustomerX509) GetCasOk() (*string, bool)` + +GetCasOk returns a tuple with the Cas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCas + +`func (o *CustomerX509) SetCas(v string)` + +SetCas sets Cas field to given value. + +### HasCas + +`func (o *CustomerX509) HasCas() bool` + +HasCas returns a boolean if a field has been set. + +### GetLinks + +`func (o *CustomerX509) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *CustomerX509) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *CustomerX509) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *CustomerX509) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DBAction.md b/docs/docs/DBAction.md new file mode 100644 index 00000000..914bf5f8 --- /dev/null +++ b/docs/docs/DBAction.md @@ -0,0 +1,77 @@ +# DBAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Action** | **string** | Human-readable label that identifies the privilege action. | +**Resources** | Pointer to [**[]DBResource**](DBResource.md) | List of resources on which you grant the action. | [optional] + +## Methods + +### NewDBAction + +`func NewDBAction(action string, ) *DBAction` + +NewDBAction instantiates a new DBAction object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDBActionWithDefaults + +`func NewDBActionWithDefaults() *DBAction` + +NewDBActionWithDefaults instantiates a new DBAction object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAction + +`func (o *DBAction) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *DBAction) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *DBAction) SetAction(v string)` + +SetAction sets Action field to given value. + + +### GetResources + +`func (o *DBAction) GetResources() []DBResource` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *DBAction) GetResourcesOk() (*[]DBResource, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *DBAction) SetResources(v []DBResource)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *DBAction) HasResources() bool` + +HasResources returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DBResource.md b/docs/docs/DBResource.md new file mode 100644 index 00000000..585ca350 --- /dev/null +++ b/docs/docs/DBResource.md @@ -0,0 +1,93 @@ +# DBResource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Cluster** | **bool** | Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters. | +**Collection** | **string** | Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter. | +**Db** | **string** | Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter. | + +## Methods + +### NewDBResource + +`func NewDBResource(cluster bool, collection string, db string, ) *DBResource` + +NewDBResource instantiates a new DBResource object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDBResourceWithDefaults + +`func NewDBResourceWithDefaults() *DBResource` + +NewDBResourceWithDefaults instantiates a new DBResource object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCluster + +`func (o *DBResource) GetCluster() bool` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *DBResource) GetClusterOk() (*bool, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *DBResource) SetCluster(v bool)` + +SetCluster sets Cluster field to given value. + + +### GetCollection + +`func (o *DBResource) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *DBResource) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *DBResource) SetCollection(v string)` + +SetCollection sets Collection field to given value. + + +### GetDb + +`func (o *DBResource) GetDb() string` + +GetDb returns the Db field if non-nil, zero value otherwise. + +### GetDbOk + +`func (o *DBResource) GetDbOk() (*string, bool)` + +GetDbOk returns a tuple with the Db field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDb + +`func (o *DBResource) SetDb(v string)` + +SetDb sets Db field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DLSIngestionSink.md b/docs/docs/DLSIngestionSink.md new file mode 100644 index 00000000..0b6edc9a --- /dev/null +++ b/docs/docs/DLSIngestionSink.md @@ -0,0 +1,134 @@ +# DLSIngestionSink + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetadataProvider** | Pointer to **string** | Target cloud provider for this Data Lake Pipeline. | [optional] +**MetadataRegion** | Pointer to **string** | Target cloud provider region for this Data Lake Pipeline. | [optional] +**PartitionFields** | Pointer to [**[]PartitionField**](PartitionField.md) | Ordered fields used to physically organize data in the destination. | [optional] +**Type** | Pointer to **string** | Type of ingestion destination of this Data Lake Pipeline. | [optional] + +## Methods + +### NewDLSIngestionSink + +`func NewDLSIngestionSink() *DLSIngestionSink` + +NewDLSIngestionSink instantiates a new DLSIngestionSink object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDLSIngestionSinkWithDefaults + +`func NewDLSIngestionSinkWithDefaults() *DLSIngestionSink` + +NewDLSIngestionSinkWithDefaults instantiates a new DLSIngestionSink object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadataProvider + +`func (o *DLSIngestionSink) GetMetadataProvider() string` + +GetMetadataProvider returns the MetadataProvider field if non-nil, zero value otherwise. + +### GetMetadataProviderOk + +`func (o *DLSIngestionSink) GetMetadataProviderOk() (*string, bool)` + +GetMetadataProviderOk returns a tuple with the MetadataProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadataProvider + +`func (o *DLSIngestionSink) SetMetadataProvider(v string)` + +SetMetadataProvider sets MetadataProvider field to given value. + +### HasMetadataProvider + +`func (o *DLSIngestionSink) HasMetadataProvider() bool` + +HasMetadataProvider returns a boolean if a field has been set. + +### GetMetadataRegion + +`func (o *DLSIngestionSink) GetMetadataRegion() string` + +GetMetadataRegion returns the MetadataRegion field if non-nil, zero value otherwise. + +### GetMetadataRegionOk + +`func (o *DLSIngestionSink) GetMetadataRegionOk() (*string, bool)` + +GetMetadataRegionOk returns a tuple with the MetadataRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadataRegion + +`func (o *DLSIngestionSink) SetMetadataRegion(v string)` + +SetMetadataRegion sets MetadataRegion field to given value. + +### HasMetadataRegion + +`func (o *DLSIngestionSink) HasMetadataRegion() bool` + +HasMetadataRegion returns a boolean if a field has been set. + +### GetPartitionFields + +`func (o *DLSIngestionSink) GetPartitionFields() []PartitionField` + +GetPartitionFields returns the PartitionFields field if non-nil, zero value otherwise. + +### GetPartitionFieldsOk + +`func (o *DLSIngestionSink) GetPartitionFieldsOk() (*[]PartitionField, bool)` + +GetPartitionFieldsOk returns a tuple with the PartitionFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartitionFields + +`func (o *DLSIngestionSink) SetPartitionFields(v []PartitionField)` + +SetPartitionFields sets PartitionFields field to given value. + +### HasPartitionFields + +`func (o *DLSIngestionSink) HasPartitionFields() bool` + +HasPartitionFields returns a boolean if a field has been set. + +### GetType + +`func (o *DLSIngestionSink) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DLSIngestionSink) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DLSIngestionSink) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DLSIngestionSink) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DailySchedule.md b/docs/docs/DailySchedule.md new file mode 100644 index 00000000..42a4a986 --- /dev/null +++ b/docs/docs/DailySchedule.md @@ -0,0 +1,155 @@ +# DailySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndHour** | Pointer to **int** | Hour of the day when the scheduled window to run one online archive ends. | [optional] +**EndMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive ends. | [optional] +**StartHour** | Pointer to **int** | Hour of the day when the when the scheduled window to run one online archive starts. | [optional] +**StartMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive starts. | [optional] +**Type** | **string** | | + +## Methods + +### NewDailySchedule + +`func NewDailySchedule(type_ string, ) *DailySchedule` + +NewDailySchedule instantiates a new DailySchedule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDailyScheduleWithDefaults + +`func NewDailyScheduleWithDefaults() *DailySchedule` + +NewDailyScheduleWithDefaults instantiates a new DailySchedule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndHour + +`func (o *DailySchedule) GetEndHour() int` + +GetEndHour returns the EndHour field if non-nil, zero value otherwise. + +### GetEndHourOk + +`func (o *DailySchedule) GetEndHourOk() (*int, bool)` + +GetEndHourOk returns a tuple with the EndHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndHour + +`func (o *DailySchedule) SetEndHour(v int)` + +SetEndHour sets EndHour field to given value. + +### HasEndHour + +`func (o *DailySchedule) HasEndHour() bool` + +HasEndHour returns a boolean if a field has been set. + +### GetEndMinute + +`func (o *DailySchedule) GetEndMinute() int` + +GetEndMinute returns the EndMinute field if non-nil, zero value otherwise. + +### GetEndMinuteOk + +`func (o *DailySchedule) GetEndMinuteOk() (*int, bool)` + +GetEndMinuteOk returns a tuple with the EndMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndMinute + +`func (o *DailySchedule) SetEndMinute(v int)` + +SetEndMinute sets EndMinute field to given value. + +### HasEndMinute + +`func (o *DailySchedule) HasEndMinute() bool` + +HasEndMinute returns a boolean if a field has been set. + +### GetStartHour + +`func (o *DailySchedule) GetStartHour() int` + +GetStartHour returns the StartHour field if non-nil, zero value otherwise. + +### GetStartHourOk + +`func (o *DailySchedule) GetStartHourOk() (*int, bool)` + +GetStartHourOk returns a tuple with the StartHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartHour + +`func (o *DailySchedule) SetStartHour(v int)` + +SetStartHour sets StartHour field to given value. + +### HasStartHour + +`func (o *DailySchedule) HasStartHour() bool` + +HasStartHour returns a boolean if a field has been set. + +### GetStartMinute + +`func (o *DailySchedule) GetStartMinute() int` + +GetStartMinute returns the StartMinute field if non-nil, zero value otherwise. + +### GetStartMinuteOk + +`func (o *DailySchedule) GetStartMinuteOk() (*int, bool)` + +GetStartMinuteOk returns a tuple with the StartMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartMinute + +`func (o *DailySchedule) SetStartMinute(v int)` + +SetStartMinute sets StartMinute field to given value. + +### HasStartMinute + +`func (o *DailySchedule) HasStartMinute() bool` + +HasStartMinute returns a boolean if a field has been set. + +### GetType + +`func (o *DailySchedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DailySchedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DailySchedule) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataExplorerAccessedEvent.md b/docs/docs/DataExplorerAccessedEvent.md new file mode 100644 index 00000000..96e3c3f3 --- /dev/null +++ b/docs/docs/DataExplorerAccessedEvent.md @@ -0,0 +1,431 @@ +# DataExplorerAccessedEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Collection** | Pointer to **string** | Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**Database** | Pointer to **string** | Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`. | [optional] [readonly] +**EventTypeName** | [**DataExplorerAccessedEventType**](DataExplorerAccessedEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OpType** | Pointer to **string** | Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewDataExplorerAccessedEvent + +`func NewDataExplorerAccessedEvent(created time.Time, eventTypeName DataExplorerAccessedEventType, id string, ) *DataExplorerAccessedEvent` + +NewDataExplorerAccessedEvent instantiates a new DataExplorerAccessedEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataExplorerAccessedEventWithDefaults + +`func NewDataExplorerAccessedEventWithDefaults() *DataExplorerAccessedEvent` + +NewDataExplorerAccessedEventWithDefaults instantiates a new DataExplorerAccessedEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *DataExplorerAccessedEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *DataExplorerAccessedEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *DataExplorerAccessedEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *DataExplorerAccessedEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCollection + +`func (o *DataExplorerAccessedEvent) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *DataExplorerAccessedEvent) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *DataExplorerAccessedEvent) SetCollection(v string)` + +SetCollection sets Collection field to given value. + +### HasCollection + +`func (o *DataExplorerAccessedEvent) HasCollection() bool` + +HasCollection returns a boolean if a field has been set. + +### GetCreated + +`func (o *DataExplorerAccessedEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DataExplorerAccessedEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DataExplorerAccessedEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetDatabase + +`func (o *DataExplorerAccessedEvent) GetDatabase() string` + +GetDatabase returns the Database field if non-nil, zero value otherwise. + +### GetDatabaseOk + +`func (o *DataExplorerAccessedEvent) GetDatabaseOk() (*string, bool)` + +GetDatabaseOk returns a tuple with the Database field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabase + +`func (o *DataExplorerAccessedEvent) SetDatabase(v string)` + +SetDatabase sets Database field to given value. + +### HasDatabase + +`func (o *DataExplorerAccessedEvent) HasDatabase() bool` + +HasDatabase returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *DataExplorerAccessedEvent) GetEventTypeName() DataExplorerAccessedEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *DataExplorerAccessedEvent) GetEventTypeNameOk() (*DataExplorerAccessedEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *DataExplorerAccessedEvent) SetEventTypeName(v DataExplorerAccessedEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *DataExplorerAccessedEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DataExplorerAccessedEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DataExplorerAccessedEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *DataExplorerAccessedEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *DataExplorerAccessedEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DataExplorerAccessedEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DataExplorerAccessedEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *DataExplorerAccessedEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *DataExplorerAccessedEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *DataExplorerAccessedEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *DataExplorerAccessedEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *DataExplorerAccessedEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DataExplorerAccessedEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DataExplorerAccessedEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DataExplorerAccessedEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOpType + +`func (o *DataExplorerAccessedEvent) GetOpType() string` + +GetOpType returns the OpType field if non-nil, zero value otherwise. + +### GetOpTypeOk + +`func (o *DataExplorerAccessedEvent) GetOpTypeOk() (*string, bool)` + +GetOpTypeOk returns a tuple with the OpType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpType + +`func (o *DataExplorerAccessedEvent) SetOpType(v string)` + +SetOpType sets OpType field to given value. + +### HasOpType + +`func (o *DataExplorerAccessedEvent) HasOpType() bool` + +HasOpType returns a boolean if a field has been set. + +### GetOrgId + +`func (o *DataExplorerAccessedEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *DataExplorerAccessedEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *DataExplorerAccessedEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *DataExplorerAccessedEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *DataExplorerAccessedEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *DataExplorerAccessedEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *DataExplorerAccessedEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *DataExplorerAccessedEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *DataExplorerAccessedEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *DataExplorerAccessedEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *DataExplorerAccessedEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *DataExplorerAccessedEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *DataExplorerAccessedEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *DataExplorerAccessedEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *DataExplorerAccessedEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *DataExplorerAccessedEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *DataExplorerAccessedEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *DataExplorerAccessedEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *DataExplorerAccessedEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *DataExplorerAccessedEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *DataExplorerAccessedEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *DataExplorerAccessedEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *DataExplorerAccessedEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *DataExplorerAccessedEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataExplorerAccessedEventType.md b/docs/docs/DataExplorerAccessedEventType.md new file mode 100644 index 00000000..c737d16e --- /dev/null +++ b/docs/docs/DataExplorerAccessedEventType.md @@ -0,0 +1,17 @@ +# DataExplorerAccessedEventType + +## Enum + + +* `EXPLORER` (value: `"DATA_EXPLORER"`) + +* `EXPLORER_CRUD_ATTEMPT` (value: `"DATA_EXPLORER_CRUD_ATTEMPT"`) + +* `EXPLORER_CRUD_ERROR` (value: `"DATA_EXPLORER_CRUD_ERROR"`) + +* `EXPLORER_CRUD` (value: `"DATA_EXPLORER_CRUD"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataFederationApi.md b/docs/docs/DataFederationApi.md new file mode 100644 index 00000000..4eed3d4c --- /dev/null +++ b/docs/docs/DataFederationApi.md @@ -0,0 +1,1109 @@ +# \DataFederationApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateDataFederationPrivateEndpoint**](DataFederationApi.md#CreateDataFederationPrivateEndpoint) | **Post** /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds | Create One Federated Database Instance and Online Archive Private Endpoint for One Project +[**CreateFederatedDatabase**](DataFederationApi.md#CreateFederatedDatabase) | **Post** /api/atlas/v2/groups/{groupId}/dataFederation | Create One Federated Database Instance in One Project +[**CreateOneDataFederationQueryLimit**](DataFederationApi.md#CreateOneDataFederationQueryLimit) | **Patch** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName} | Configure One Query Limit for One Federated Database Instance +[**DeleteDataFederationPrivateEndpoint**](DataFederationApi.md#DeleteDataFederationPrivateEndpoint) | **Delete** /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId} | Remove One Federated Database Instance and Online Archive Private Endpoint from One Project +[**DeleteFederatedDatabase**](DataFederationApi.md#DeleteFederatedDatabase) | **Delete** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} | Remove One Federated Database Instance from One Project +[**DeleteOneDataFederationInstanceQueryLimit**](DataFederationApi.md#DeleteOneDataFederationInstanceQueryLimit) | **Delete** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName} | Delete One Query Limit For One Federated Database Instance +[**DownloadFederatedDatabaseQueryLogs**](DataFederationApi.md#DownloadFederatedDatabaseQueryLogs) | **Get** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz | Download Query Logs for One Federated Database Instance +[**GetDataFederationPrivateEndpoint**](DataFederationApi.md#GetDataFederationPrivateEndpoint) | **Get** /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId} | Return One Federated Database Instance and Online Archive Private Endpoint in One Project +[**GetFederatedDatabase**](DataFederationApi.md#GetFederatedDatabase) | **Get** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} | Return One Federated Database Instance in One Project +[**ListDataFederationPrivateEndpoints**](DataFederationApi.md#ListDataFederationPrivateEndpoints) | **Get** /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds | Return All Federated Database Instance and Online Archive Private Endpoints in One Project +[**ListFederatedDatabases**](DataFederationApi.md#ListFederatedDatabases) | **Get** /api/atlas/v2/groups/{groupId}/dataFederation | Return All Federated Database Instances in One Project +[**ReturnFederatedDatabaseQueryLimit**](DataFederationApi.md#ReturnFederatedDatabaseQueryLimit) | **Get** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName} | Return One Federated Database Instance Query Limit for One Project +[**ReturnFederatedDatabaseQueryLimits**](DataFederationApi.md#ReturnFederatedDatabaseQueryLimits) | **Get** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits | Return All Query Limits for One Federated Database Instance +[**UpdateFederatedDatabase**](DataFederationApi.md#UpdateFederatedDatabase) | **Patch** /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} | Update One Federated Database Instance in One Project + + + +## CreateDataFederationPrivateEndpoint + +> []PrivateNetworkEndpointIdEntry CreateDataFederationPrivateEndpoint(ctx, groupId).PrivateNetworkEndpointIdEntry(privateNetworkEndpointIdEntry).Execute() + +Create One Federated Database Instance and Online Archive Private Endpoint for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + privateNetworkEndpointIdEntry := *openapiclient.NewPrivateNetworkEndpointIdEntry("vpce-3bf78b0ddee411ba1") // PrivateNetworkEndpointIdEntry | + + resp, r, err := sdk.DataFederationApi.CreateDataFederationPrivateEndpoint(context.Background(), groupId).PrivateNetworkEndpointIdEntry(privateNetworkEndpointIdEntry).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.CreateDataFederationPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateDataFederationPrivateEndpoint`: []PrivateNetworkEndpointIdEntry + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.CreateDataFederationPrivateEndpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDataFederationPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **privateNetworkEndpointIdEntry** | [**PrivateNetworkEndpointIdEntry**](PrivateNetworkEndpointIdEntry.md) | Private endpoint for Federated Database Instances and Online Archives to add to the specified project. | + +### Return type + +[**[]PrivateNetworkEndpointIdEntry**](PrivateNetworkEndpointIdEntry.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateFederatedDatabase + +> DataLakeTenant CreateFederatedDatabase(ctx, groupId).DataLakeTenant(dataLakeTenant).SkipRoleValidation(skipRoleValidation).Execute() + +Create One Federated Database Instance in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + dataLakeTenant := *openapiclient.NewDataLakeTenant() // DataLakeTenant | + skipRoleValidation := true // bool | (optional) (default to false) + + resp, r, err := sdk.DataFederationApi.CreateFederatedDatabase(context.Background(), groupId).DataLakeTenant(dataLakeTenant).SkipRoleValidation(skipRoleValidation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.CreateFederatedDatabase``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateFederatedDatabase`: DataLakeTenant + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.CreateFederatedDatabase`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFederatedDatabaseRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **dataLakeTenant** | [**DataLakeTenant**](DataLakeTenant.md) | Details to create one federated database instance in the specified project. | + **skipRoleValidation** | **bool** | Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. | [default to false] + +### Return type + +[**DataLakeTenant**](DataLakeTenant.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateOneDataFederationQueryLimit + +> []DataFederationTenantQueryLimit CreateOneDataFederationQueryLimit(ctx, groupId, tenantName, limitName).DataFederationTenantQueryLimit(dataFederationTenantQueryLimit).Execute() + +Configure One Query Limit for One Federated Database Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + limitName := "limitName_example" // string | + dataFederationTenantQueryLimit := *openapiclient.NewDataFederationTenantQueryLimit("Name_example", int64(123)) // DataFederationTenantQueryLimit | + + resp, r, err := sdk.DataFederationApi.CreateOneDataFederationQueryLimit(context.Background(), groupId, tenantName, limitName).DataFederationTenantQueryLimit(dataFederationTenantQueryLimit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.CreateOneDataFederationQueryLimit``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateOneDataFederationQueryLimit`: []DataFederationTenantQueryLimit + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.CreateOneDataFederationQueryLimit`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the federated database instance to which the query limit applies. | +**limitName** | **string** | Human-readable label that identifies this data federation instance limit. | Limit Name | Description | Default | | --- | --- | --- | | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOneDataFederationQueryLimitRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **dataFederationTenantQueryLimit** | [**DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md) | Creates or updates one query limit for one federated database instance. | + +### Return type + +[**[]DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteDataFederationPrivateEndpoint + +> DeleteDataFederationPrivateEndpoint(ctx, groupId, endpointId).Execute() + +Remove One Federated Database Instance and Online Archive Private Endpoint from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + endpointId := "endpointId_example" // string | + + r, err := sdk.DataFederationApi.DeleteDataFederationPrivateEndpoint(context.Background(), groupId, endpointId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.DeleteDataFederationPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**endpointId** | **string** | Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDataFederationPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteFederatedDatabase + +> DeleteFederatedDatabase(ctx, groupId, tenantName).Execute() + +Remove One Federated Database Instance from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + + r, err := sdk.DataFederationApi.DeleteFederatedDatabase(context.Background(), groupId, tenantName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.DeleteFederatedDatabase``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the federated database instance to remove. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteFederatedDatabaseRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteOneDataFederationInstanceQueryLimit + +> DeleteOneDataFederationInstanceQueryLimit(ctx, groupId, tenantName, limitName).Execute() + +Delete One Query Limit For One Federated Database Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + limitName := "limitName_example" // string | + + r, err := sdk.DataFederationApi.DeleteOneDataFederationInstanceQueryLimit(context.Background(), groupId, tenantName, limitName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.DeleteOneDataFederationInstanceQueryLimit``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the federated database instance to which the query limit applies. | +**limitName** | **string** | Human-readable label that identifies this data federation instance limit. | Limit Name | Description | Default | | --- | --- | --- | | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOneDataFederationInstanceQueryLimitRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DownloadFederatedDatabaseQueryLogs + +> *os.File DownloadFederatedDatabaseQueryLogs(ctx, groupId, tenantName).EndDate(endDate).StartDate(startDate).Execute() + +Download Query Logs for One Federated Database Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + endDate := int64(1636481348) // int64 | (optional) + startDate := int64(1636466948) // int64 | (optional) + + resp, r, err := sdk.DataFederationApi.DownloadFederatedDatabaseQueryLogs(context.Background(), groupId, tenantName).EndDate(endDate).StartDate(startDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.DownloadFederatedDatabaseQueryLogs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DownloadFederatedDatabaseQueryLogs`: *os.File + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.DownloadFederatedDatabaseQueryLogs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the federated database instance for which you want to download query logs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadFederatedDatabaseQueryLogsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **endDate** | **int64** | Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. | + **startDate** | **int64** | Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. | + +### Return type + +[***os.File**](*os.File.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+gzip, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetDataFederationPrivateEndpoint + +> PrivateNetworkEndpointIdEntry GetDataFederationPrivateEndpoint(ctx, groupId, endpointId).Execute() + +Return One Federated Database Instance and Online Archive Private Endpoint in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + endpointId := "endpointId_example" // string | + + resp, r, err := sdk.DataFederationApi.GetDataFederationPrivateEndpoint(context.Background(), groupId, endpointId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.GetDataFederationPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetDataFederationPrivateEndpoint`: PrivateNetworkEndpointIdEntry + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.GetDataFederationPrivateEndpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**endpointId** | **string** | Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataFederationPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**PrivateNetworkEndpointIdEntry**](PrivateNetworkEndpointIdEntry.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetFederatedDatabase + +> DataLakeTenant GetFederatedDatabase(ctx, groupId, tenantName).Execute() + +Return One Federated Database Instance in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + + resp, r, err := sdk.DataFederationApi.GetFederatedDatabase(context.Background(), groupId, tenantName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.GetFederatedDatabase``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetFederatedDatabase`: DataLakeTenant + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.GetFederatedDatabase`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the Federated Database to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFederatedDatabaseRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**DataLakeTenant**](DataLakeTenant.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListDataFederationPrivateEndpoints + +> []PrivateNetworkEndpointIdEntry ListDataFederationPrivateEndpoints(ctx, groupId).Execute() + +Return All Federated Database Instance and Online Archive Private Endpoints in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.DataFederationApi.ListDataFederationPrivateEndpoints(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.ListDataFederationPrivateEndpoints``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListDataFederationPrivateEndpoints`: []PrivateNetworkEndpointIdEntry + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.ListDataFederationPrivateEndpoints`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDataFederationPrivateEndpointsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]PrivateNetworkEndpointIdEntry**](PrivateNetworkEndpointIdEntry.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListFederatedDatabases + +> []DataLakeTenant ListFederatedDatabases(ctx, groupId).Type_(type_).Execute() + +Return All Federated Database Instances in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + type_ := "type__example" // string | (optional) (default to "USER") + + resp, r, err := sdk.DataFederationApi.ListFederatedDatabases(context.Background(), groupId).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.ListFederatedDatabases``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListFederatedDatabases`: []DataLakeTenant + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.ListFederatedDatabases`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListFederatedDatabasesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **type_** | **string** | Type of Federated Database Instances to return. | [default to "USER"] + +### Return type + +[**[]DataLakeTenant**](DataLakeTenant.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ReturnFederatedDatabaseQueryLimit + +> []DataFederationTenantQueryLimit ReturnFederatedDatabaseQueryLimit(ctx, groupId, tenantName, limitName).Execute() + +Return One Federated Database Instance Query Limit for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + limitName := "limitName_example" // string | + + resp, r, err := sdk.DataFederationApi.ReturnFederatedDatabaseQueryLimit(context.Background(), groupId, tenantName, limitName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.ReturnFederatedDatabaseQueryLimit``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ReturnFederatedDatabaseQueryLimit`: []DataFederationTenantQueryLimit + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.ReturnFederatedDatabaseQueryLimit`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the federated database instance to which the query limit applies. | +**limitName** | **string** | Human-readable label that identifies this data federation instance limit. | Limit Name | Description | Default | | --- | --- | --- | | bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A | | bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A | | bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A | | bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiReturnFederatedDatabaseQueryLimitRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**[]DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ReturnFederatedDatabaseQueryLimits + +> []DataFederationTenantQueryLimit ReturnFederatedDatabaseQueryLimits(ctx, groupId, tenantName).Execute() + +Return All Query Limits for One Federated Database Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + + resp, r, err := sdk.DataFederationApi.ReturnFederatedDatabaseQueryLimits(context.Background(), groupId, tenantName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.ReturnFederatedDatabaseQueryLimits``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ReturnFederatedDatabaseQueryLimits`: []DataFederationTenantQueryLimit + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.ReturnFederatedDatabaseQueryLimits`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the federated database instance for which you want to retrieve query limits. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiReturnFederatedDatabaseQueryLimitsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**[]DataFederationTenantQueryLimit**](DataFederationTenantQueryLimit.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateFederatedDatabase + +> DataLakeTenant UpdateFederatedDatabase(ctx, groupId, tenantName).SkipRoleValidation(skipRoleValidation).DataLakeTenant(dataLakeTenant).Execute() + +Update One Federated Database Instance in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantName := "tenantName_example" // string | + skipRoleValidation := true // bool | + dataLakeTenant := *openapiclient.NewDataLakeTenant() // DataLakeTenant | + + resp, r, err := sdk.DataFederationApi.UpdateFederatedDatabase(context.Background(), groupId, tenantName).SkipRoleValidation(skipRoleValidation).DataLakeTenant(dataLakeTenant).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataFederationApi.UpdateFederatedDatabase``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateFederatedDatabase`: DataLakeTenant + fmt.Fprintf(os.Stdout, "Response from `DataFederationApi.UpdateFederatedDatabase`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**tenantName** | **string** | Human-readable label that identifies the federated database instance to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateFederatedDatabaseRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **skipRoleValidation** | **bool** | Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. | + **dataLakeTenant** | [**DataLakeTenant**](DataLakeTenant.md) | Details of one Federated Database to update in the specified project. | + +### Return type + +[**DataLakeTenant**](DataLakeTenant.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/DataFederationQueryLimit.md b/docs/docs/DataFederationQueryLimit.md new file mode 100644 index 00000000..9e6927a9 --- /dev/null +++ b/docs/docs/DataFederationQueryLimit.md @@ -0,0 +1,202 @@ +# DataFederationQueryLimit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CurrentUsage** | Pointer to **int64** | Amount that indicates the current usage of the limit. | [optional] [readonly] +**DefaultLimit** | Pointer to **int64** | Default value of the limit. | [optional] [readonly] +**LastModifiedDate** | Pointer to **time.Time** | Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**MaximumLimit** | Pointer to **int64** | Maximum value of the limit. | [optional] [readonly] +**Name** | **string** | Human-readable label that identifies the user-managed limit to modify. | [readonly] +**OverrunPolicy** | Pointer to **string** | Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. | [optional] +**Value** | **int64** | Amount to set the limit to. | + +## Methods + +### NewDataFederationQueryLimit + +`func NewDataFederationQueryLimit(name string, value int64, ) *DataFederationQueryLimit` + +NewDataFederationQueryLimit instantiates a new DataFederationQueryLimit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataFederationQueryLimitWithDefaults + +`func NewDataFederationQueryLimitWithDefaults() *DataFederationQueryLimit` + +NewDataFederationQueryLimitWithDefaults instantiates a new DataFederationQueryLimit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCurrentUsage + +`func (o *DataFederationQueryLimit) GetCurrentUsage() int64` + +GetCurrentUsage returns the CurrentUsage field if non-nil, zero value otherwise. + +### GetCurrentUsageOk + +`func (o *DataFederationQueryLimit) GetCurrentUsageOk() (*int64, bool)` + +GetCurrentUsageOk returns a tuple with the CurrentUsage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentUsage + +`func (o *DataFederationQueryLimit) SetCurrentUsage(v int64)` + +SetCurrentUsage sets CurrentUsage field to given value. + +### HasCurrentUsage + +`func (o *DataFederationQueryLimit) HasCurrentUsage() bool` + +HasCurrentUsage returns a boolean if a field has been set. + +### GetDefaultLimit + +`func (o *DataFederationQueryLimit) GetDefaultLimit() int64` + +GetDefaultLimit returns the DefaultLimit field if non-nil, zero value otherwise. + +### GetDefaultLimitOk + +`func (o *DataFederationQueryLimit) GetDefaultLimitOk() (*int64, bool)` + +GetDefaultLimitOk returns a tuple with the DefaultLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultLimit + +`func (o *DataFederationQueryLimit) SetDefaultLimit(v int64)` + +SetDefaultLimit sets DefaultLimit field to given value. + +### HasDefaultLimit + +`func (o *DataFederationQueryLimit) HasDefaultLimit() bool` + +HasDefaultLimit returns a boolean if a field has been set. + +### GetLastModifiedDate + +`func (o *DataFederationQueryLimit) GetLastModifiedDate() time.Time` + +GetLastModifiedDate returns the LastModifiedDate field if non-nil, zero value otherwise. + +### GetLastModifiedDateOk + +`func (o *DataFederationQueryLimit) GetLastModifiedDateOk() (*time.Time, bool)` + +GetLastModifiedDateOk returns a tuple with the LastModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastModifiedDate + +`func (o *DataFederationQueryLimit) SetLastModifiedDate(v time.Time)` + +SetLastModifiedDate sets LastModifiedDate field to given value. + +### HasLastModifiedDate + +`func (o *DataFederationQueryLimit) HasLastModifiedDate() bool` + +HasLastModifiedDate returns a boolean if a field has been set. + +### GetMaximumLimit + +`func (o *DataFederationQueryLimit) GetMaximumLimit() int64` + +GetMaximumLimit returns the MaximumLimit field if non-nil, zero value otherwise. + +### GetMaximumLimitOk + +`func (o *DataFederationQueryLimit) GetMaximumLimitOk() (*int64, bool)` + +GetMaximumLimitOk returns a tuple with the MaximumLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaximumLimit + +`func (o *DataFederationQueryLimit) SetMaximumLimit(v int64)` + +SetMaximumLimit sets MaximumLimit field to given value. + +### HasMaximumLimit + +`func (o *DataFederationQueryLimit) HasMaximumLimit() bool` + +HasMaximumLimit returns a boolean if a field has been set. + +### GetName + +`func (o *DataFederationQueryLimit) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataFederationQueryLimit) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataFederationQueryLimit) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOverrunPolicy + +`func (o *DataFederationQueryLimit) GetOverrunPolicy() string` + +GetOverrunPolicy returns the OverrunPolicy field if non-nil, zero value otherwise. + +### GetOverrunPolicyOk + +`func (o *DataFederationQueryLimit) GetOverrunPolicyOk() (*string, bool)` + +GetOverrunPolicyOk returns a tuple with the OverrunPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOverrunPolicy + +`func (o *DataFederationQueryLimit) SetOverrunPolicy(v string)` + +SetOverrunPolicy sets OverrunPolicy field to given value. + +### HasOverrunPolicy + +`func (o *DataFederationQueryLimit) HasOverrunPolicy() bool` + +HasOverrunPolicy returns a boolean if a field has been set. + +### GetValue + +`func (o *DataFederationQueryLimit) GetValue() int64` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataFederationQueryLimit) GetValueOk() (*int64, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataFederationQueryLimit) SetValue(v int64)` + +SetValue sets Value field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataFederationTenantQueryLimit.md b/docs/docs/DataFederationTenantQueryLimit.md new file mode 100644 index 00000000..f08f2a8e --- /dev/null +++ b/docs/docs/DataFederationTenantQueryLimit.md @@ -0,0 +1,228 @@ +# DataFederationTenantQueryLimit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CurrentUsage** | Pointer to **int64** | Amount that indicates the current usage of the limit. | [optional] [readonly] +**DefaultLimit** | Pointer to **int64** | Default value of the limit. | [optional] [readonly] +**LastModifiedDate** | Pointer to **time.Time** | Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**MaximumLimit** | Pointer to **int64** | Maximum value of the limit. | [optional] [readonly] +**Name** | **string** | Human-readable label that identifies the user-managed limit to modify. | [readonly] +**OverrunPolicy** | Pointer to **string** | Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. | [optional] +**TenantName** | Pointer to **string** | Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project. | [optional] [readonly] +**Value** | **int64** | Amount to set the limit to. | + +## Methods + +### NewDataFederationTenantQueryLimit + +`func NewDataFederationTenantQueryLimit(name string, value int64, ) *DataFederationTenantQueryLimit` + +NewDataFederationTenantQueryLimit instantiates a new DataFederationTenantQueryLimit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataFederationTenantQueryLimitWithDefaults + +`func NewDataFederationTenantQueryLimitWithDefaults() *DataFederationTenantQueryLimit` + +NewDataFederationTenantQueryLimitWithDefaults instantiates a new DataFederationTenantQueryLimit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCurrentUsage + +`func (o *DataFederationTenantQueryLimit) GetCurrentUsage() int64` + +GetCurrentUsage returns the CurrentUsage field if non-nil, zero value otherwise. + +### GetCurrentUsageOk + +`func (o *DataFederationTenantQueryLimit) GetCurrentUsageOk() (*int64, bool)` + +GetCurrentUsageOk returns a tuple with the CurrentUsage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentUsage + +`func (o *DataFederationTenantQueryLimit) SetCurrentUsage(v int64)` + +SetCurrentUsage sets CurrentUsage field to given value. + +### HasCurrentUsage + +`func (o *DataFederationTenantQueryLimit) HasCurrentUsage() bool` + +HasCurrentUsage returns a boolean if a field has been set. + +### GetDefaultLimit + +`func (o *DataFederationTenantQueryLimit) GetDefaultLimit() int64` + +GetDefaultLimit returns the DefaultLimit field if non-nil, zero value otherwise. + +### GetDefaultLimitOk + +`func (o *DataFederationTenantQueryLimit) GetDefaultLimitOk() (*int64, bool)` + +GetDefaultLimitOk returns a tuple with the DefaultLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultLimit + +`func (o *DataFederationTenantQueryLimit) SetDefaultLimit(v int64)` + +SetDefaultLimit sets DefaultLimit field to given value. + +### HasDefaultLimit + +`func (o *DataFederationTenantQueryLimit) HasDefaultLimit() bool` + +HasDefaultLimit returns a boolean if a field has been set. + +### GetLastModifiedDate + +`func (o *DataFederationTenantQueryLimit) GetLastModifiedDate() time.Time` + +GetLastModifiedDate returns the LastModifiedDate field if non-nil, zero value otherwise. + +### GetLastModifiedDateOk + +`func (o *DataFederationTenantQueryLimit) GetLastModifiedDateOk() (*time.Time, bool)` + +GetLastModifiedDateOk returns a tuple with the LastModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastModifiedDate + +`func (o *DataFederationTenantQueryLimit) SetLastModifiedDate(v time.Time)` + +SetLastModifiedDate sets LastModifiedDate field to given value. + +### HasLastModifiedDate + +`func (o *DataFederationTenantQueryLimit) HasLastModifiedDate() bool` + +HasLastModifiedDate returns a boolean if a field has been set. + +### GetMaximumLimit + +`func (o *DataFederationTenantQueryLimit) GetMaximumLimit() int64` + +GetMaximumLimit returns the MaximumLimit field if non-nil, zero value otherwise. + +### GetMaximumLimitOk + +`func (o *DataFederationTenantQueryLimit) GetMaximumLimitOk() (*int64, bool)` + +GetMaximumLimitOk returns a tuple with the MaximumLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaximumLimit + +`func (o *DataFederationTenantQueryLimit) SetMaximumLimit(v int64)` + +SetMaximumLimit sets MaximumLimit field to given value. + +### HasMaximumLimit + +`func (o *DataFederationTenantQueryLimit) HasMaximumLimit() bool` + +HasMaximumLimit returns a boolean if a field has been set. + +### GetName + +`func (o *DataFederationTenantQueryLimit) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataFederationTenantQueryLimit) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataFederationTenantQueryLimit) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOverrunPolicy + +`func (o *DataFederationTenantQueryLimit) GetOverrunPolicy() string` + +GetOverrunPolicy returns the OverrunPolicy field if non-nil, zero value otherwise. + +### GetOverrunPolicyOk + +`func (o *DataFederationTenantQueryLimit) GetOverrunPolicyOk() (*string, bool)` + +GetOverrunPolicyOk returns a tuple with the OverrunPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOverrunPolicy + +`func (o *DataFederationTenantQueryLimit) SetOverrunPolicy(v string)` + +SetOverrunPolicy sets OverrunPolicy field to given value. + +### HasOverrunPolicy + +`func (o *DataFederationTenantQueryLimit) HasOverrunPolicy() bool` + +HasOverrunPolicy returns a boolean if a field has been set. + +### GetTenantName + +`func (o *DataFederationTenantQueryLimit) GetTenantName() string` + +GetTenantName returns the TenantName field if non-nil, zero value otherwise. + +### GetTenantNameOk + +`func (o *DataFederationTenantQueryLimit) GetTenantNameOk() (*string, bool)` + +GetTenantNameOk returns a tuple with the TenantName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantName + +`func (o *DataFederationTenantQueryLimit) SetTenantName(v string)` + +SetTenantName sets TenantName field to given value. + +### HasTenantName + +`func (o *DataFederationTenantQueryLimit) HasTenantName() bool` + +HasTenantName returns a boolean if a field has been set. + +### GetValue + +`func (o *DataFederationTenantQueryLimit) GetValue() int64` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataFederationTenantQueryLimit) GetValueOk() (*int64, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataFederationTenantQueryLimit) SetValue(v int64)` + +SetValue sets Value field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeAWSCloudProviderConfig.md b/docs/docs/DataLakeAWSCloudProviderConfig.md new file mode 100644 index 00000000..15afb70e --- /dev/null +++ b/docs/docs/DataLakeAWSCloudProviderConfig.md @@ -0,0 +1,150 @@ +# DataLakeAWSCloudProviderConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalId** | Pointer to **string** | Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores. | [optional] [readonly] +**IamAssumedRoleARN** | Pointer to **string** | Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores. | [optional] [readonly] +**IamUserARN** | Pointer to **string** | Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. | [optional] [readonly] +**RoleId** | **string** | Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. | +**TestS3Bucket** | **string** | Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. | + +## Methods + +### NewDataLakeAWSCloudProviderConfig + +`func NewDataLakeAWSCloudProviderConfig(roleId string, testS3Bucket string, ) *DataLakeAWSCloudProviderConfig` + +NewDataLakeAWSCloudProviderConfig instantiates a new DataLakeAWSCloudProviderConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeAWSCloudProviderConfigWithDefaults + +`func NewDataLakeAWSCloudProviderConfigWithDefaults() *DataLakeAWSCloudProviderConfig` + +NewDataLakeAWSCloudProviderConfigWithDefaults instantiates a new DataLakeAWSCloudProviderConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetExternalId + +`func (o *DataLakeAWSCloudProviderConfig) GetExternalId() string` + +GetExternalId returns the ExternalId field if non-nil, zero value otherwise. + +### GetExternalIdOk + +`func (o *DataLakeAWSCloudProviderConfig) GetExternalIdOk() (*string, bool)` + +GetExternalIdOk returns a tuple with the ExternalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalId + +`func (o *DataLakeAWSCloudProviderConfig) SetExternalId(v string)` + +SetExternalId sets ExternalId field to given value. + +### HasExternalId + +`func (o *DataLakeAWSCloudProviderConfig) HasExternalId() bool` + +HasExternalId returns a boolean if a field has been set. + +### GetIamAssumedRoleARN + +`func (o *DataLakeAWSCloudProviderConfig) GetIamAssumedRoleARN() string` + +GetIamAssumedRoleARN returns the IamAssumedRoleARN field if non-nil, zero value otherwise. + +### GetIamAssumedRoleARNOk + +`func (o *DataLakeAWSCloudProviderConfig) GetIamAssumedRoleARNOk() (*string, bool)` + +GetIamAssumedRoleARNOk returns a tuple with the IamAssumedRoleARN field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIamAssumedRoleARN + +`func (o *DataLakeAWSCloudProviderConfig) SetIamAssumedRoleARN(v string)` + +SetIamAssumedRoleARN sets IamAssumedRoleARN field to given value. + +### HasIamAssumedRoleARN + +`func (o *DataLakeAWSCloudProviderConfig) HasIamAssumedRoleARN() bool` + +HasIamAssumedRoleARN returns a boolean if a field has been set. + +### GetIamUserARN + +`func (o *DataLakeAWSCloudProviderConfig) GetIamUserARN() string` + +GetIamUserARN returns the IamUserARN field if non-nil, zero value otherwise. + +### GetIamUserARNOk + +`func (o *DataLakeAWSCloudProviderConfig) GetIamUserARNOk() (*string, bool)` + +GetIamUserARNOk returns a tuple with the IamUserARN field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIamUserARN + +`func (o *DataLakeAWSCloudProviderConfig) SetIamUserARN(v string)` + +SetIamUserARN sets IamUserARN field to given value. + +### HasIamUserARN + +`func (o *DataLakeAWSCloudProviderConfig) HasIamUserARN() bool` + +HasIamUserARN returns a boolean if a field has been set. + +### GetRoleId + +`func (o *DataLakeAWSCloudProviderConfig) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *DataLakeAWSCloudProviderConfig) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *DataLakeAWSCloudProviderConfig) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + + +### GetTestS3Bucket + +`func (o *DataLakeAWSCloudProviderConfig) GetTestS3Bucket() string` + +GetTestS3Bucket returns the TestS3Bucket field if non-nil, zero value otherwise. + +### GetTestS3BucketOk + +`func (o *DataLakeAWSCloudProviderConfig) GetTestS3BucketOk() (*string, bool)` + +GetTestS3BucketOk returns a tuple with the TestS3Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTestS3Bucket + +`func (o *DataLakeAWSCloudProviderConfig) SetTestS3Bucket(v string)` + +SetTestS3Bucket sets TestS3Bucket field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeAtlasStore.md b/docs/docs/DataLakeAtlasStore.md new file mode 100644 index 00000000..3da5ed26 --- /dev/null +++ b/docs/docs/DataLakeAtlasStore.md @@ -0,0 +1,155 @@ +# DataLakeAtlasStore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | Pointer to **string** | Human-readable label of the MongoDB Cloud cluster on which the store is based. | [optional] +**ProjectId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project. | [optional] [readonly] +**ReadPreference** | Pointer to [**DataLakeAtlasStoreReadPreference**](DataLakeAtlasStoreReadPreference.md) | | [optional] +**Name** | Pointer to **string** | Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster. | [optional] +**Provider** | **string** | | + +## Methods + +### NewDataLakeAtlasStore + +`func NewDataLakeAtlasStore(provider string, ) *DataLakeAtlasStore` + +NewDataLakeAtlasStore instantiates a new DataLakeAtlasStore object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeAtlasStoreWithDefaults + +`func NewDataLakeAtlasStoreWithDefaults() *DataLakeAtlasStore` + +NewDataLakeAtlasStoreWithDefaults instantiates a new DataLakeAtlasStore object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *DataLakeAtlasStore) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *DataLakeAtlasStore) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *DataLakeAtlasStore) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *DataLakeAtlasStore) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetProjectId + +`func (o *DataLakeAtlasStore) GetProjectId() string` + +GetProjectId returns the ProjectId field if non-nil, zero value otherwise. + +### GetProjectIdOk + +`func (o *DataLakeAtlasStore) GetProjectIdOk() (*string, bool)` + +GetProjectIdOk returns a tuple with the ProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProjectId + +`func (o *DataLakeAtlasStore) SetProjectId(v string)` + +SetProjectId sets ProjectId field to given value. + +### HasProjectId + +`func (o *DataLakeAtlasStore) HasProjectId() bool` + +HasProjectId returns a boolean if a field has been set. + +### GetReadPreference + +`func (o *DataLakeAtlasStore) GetReadPreference() DataLakeAtlasStoreReadPreference` + +GetReadPreference returns the ReadPreference field if non-nil, zero value otherwise. + +### GetReadPreferenceOk + +`func (o *DataLakeAtlasStore) GetReadPreferenceOk() (*DataLakeAtlasStoreReadPreference, bool)` + +GetReadPreferenceOk returns a tuple with the ReadPreference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadPreference + +`func (o *DataLakeAtlasStore) SetReadPreference(v DataLakeAtlasStoreReadPreference)` + +SetReadPreference sets ReadPreference field to given value. + +### HasReadPreference + +`func (o *DataLakeAtlasStore) HasReadPreference() bool` + +HasReadPreference returns a boolean if a field has been set. + +### GetName + +`func (o *DataLakeAtlasStore) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeAtlasStore) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeAtlasStore) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeAtlasStore) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvider + +`func (o *DataLakeAtlasStore) GetProvider() string` + +GetProvider returns the Provider field if non-nil, zero value otherwise. + +### GetProviderOk + +`func (o *DataLakeAtlasStore) GetProviderOk() (*string, bool)` + +GetProviderOk returns a tuple with the Provider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvider + +`func (o *DataLakeAtlasStore) SetProvider(v string)` + +SetProvider sets Provider field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeAtlasStoreReadPreference.md b/docs/docs/DataLakeAtlasStoreReadPreference.md new file mode 100644 index 00000000..1824f660 --- /dev/null +++ b/docs/docs/DataLakeAtlasStoreReadPreference.md @@ -0,0 +1,108 @@ +# DataLakeAtlasStoreReadPreference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxStalenessSeconds** | Pointer to **int** | Maximum replication lag, or **staleness**, for reads from secondaries. | [optional] +**Mode** | Pointer to **string** | [Read preference mode](https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes) that specifies to which replica set member to route the read requests. | [optional] +**TagSets** | Pointer to [**[][]DataLakeAtlasStoreReadPreferenceTag**]([]DataLakeAtlasStoreReadPreferenceTag.md) | List that contains [tag sets](https://docs.mongodb.com/manual/core/read-preference-tags/) or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags. | [optional] + +## Methods + +### NewDataLakeAtlasStoreReadPreference + +`func NewDataLakeAtlasStoreReadPreference() *DataLakeAtlasStoreReadPreference` + +NewDataLakeAtlasStoreReadPreference instantiates a new DataLakeAtlasStoreReadPreference object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeAtlasStoreReadPreferenceWithDefaults + +`func NewDataLakeAtlasStoreReadPreferenceWithDefaults() *DataLakeAtlasStoreReadPreference` + +NewDataLakeAtlasStoreReadPreferenceWithDefaults instantiates a new DataLakeAtlasStoreReadPreference object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxStalenessSeconds + +`func (o *DataLakeAtlasStoreReadPreference) GetMaxStalenessSeconds() int` + +GetMaxStalenessSeconds returns the MaxStalenessSeconds field if non-nil, zero value otherwise. + +### GetMaxStalenessSecondsOk + +`func (o *DataLakeAtlasStoreReadPreference) GetMaxStalenessSecondsOk() (*int, bool)` + +GetMaxStalenessSecondsOk returns a tuple with the MaxStalenessSeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxStalenessSeconds + +`func (o *DataLakeAtlasStoreReadPreference) SetMaxStalenessSeconds(v int)` + +SetMaxStalenessSeconds sets MaxStalenessSeconds field to given value. + +### HasMaxStalenessSeconds + +`func (o *DataLakeAtlasStoreReadPreference) HasMaxStalenessSeconds() bool` + +HasMaxStalenessSeconds returns a boolean if a field has been set. + +### GetMode + +`func (o *DataLakeAtlasStoreReadPreference) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *DataLakeAtlasStoreReadPreference) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *DataLakeAtlasStoreReadPreference) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *DataLakeAtlasStoreReadPreference) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetTagSets + +`func (o *DataLakeAtlasStoreReadPreference) GetTagSets() [][]DataLakeAtlasStoreReadPreferenceTag` + +GetTagSets returns the TagSets field if non-nil, zero value otherwise. + +### GetTagSetsOk + +`func (o *DataLakeAtlasStoreReadPreference) GetTagSetsOk() (*[][]DataLakeAtlasStoreReadPreferenceTag, bool)` + +GetTagSetsOk returns a tuple with the TagSets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTagSets + +`func (o *DataLakeAtlasStoreReadPreference) SetTagSets(v [][]DataLakeAtlasStoreReadPreferenceTag)` + +SetTagSets sets TagSets field to given value. + +### HasTagSets + +`func (o *DataLakeAtlasStoreReadPreference) HasTagSets() bool` + +HasTagSets returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeAtlasStoreReadPreferenceTag.md b/docs/docs/DataLakeAtlasStoreReadPreferenceTag.md new file mode 100644 index 00000000..3464cf83 --- /dev/null +++ b/docs/docs/DataLakeAtlasStoreReadPreferenceTag.md @@ -0,0 +1,82 @@ +# DataLakeAtlasStoreReadPreferenceTag + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Human-readable label of the tag. | [optional] +**Value** | Pointer to **string** | Value of the tag. | [optional] + +## Methods + +### NewDataLakeAtlasStoreReadPreferenceTag + +`func NewDataLakeAtlasStoreReadPreferenceTag() *DataLakeAtlasStoreReadPreferenceTag` + +NewDataLakeAtlasStoreReadPreferenceTag instantiates a new DataLakeAtlasStoreReadPreferenceTag object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeAtlasStoreReadPreferenceTagWithDefaults + +`func NewDataLakeAtlasStoreReadPreferenceTagWithDefaults() *DataLakeAtlasStoreReadPreferenceTag` + +NewDataLakeAtlasStoreReadPreferenceTagWithDefaults instantiates a new DataLakeAtlasStoreReadPreferenceTag object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *DataLakeAtlasStoreReadPreferenceTag) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeAtlasStoreReadPreferenceTag) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeAtlasStoreReadPreferenceTag) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeAtlasStoreReadPreferenceTag) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *DataLakeAtlasStoreReadPreferenceTag) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataLakeAtlasStoreReadPreferenceTag) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataLakeAtlasStoreReadPreferenceTag) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataLakeAtlasStoreReadPreferenceTag) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeCloudProviderConfig.md b/docs/docs/DataLakeCloudProviderConfig.md new file mode 100644 index 00000000..ae5a5886 --- /dev/null +++ b/docs/docs/DataLakeCloudProviderConfig.md @@ -0,0 +1,51 @@ +# DataLakeCloudProviderConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Aws** | [**DataLakeAWSCloudProviderConfig**](DataLakeAWSCloudProviderConfig.md) | | + +## Methods + +### NewDataLakeCloudProviderConfig + +`func NewDataLakeCloudProviderConfig(aws DataLakeAWSCloudProviderConfig, ) *DataLakeCloudProviderConfig` + +NewDataLakeCloudProviderConfig instantiates a new DataLakeCloudProviderConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeCloudProviderConfigWithDefaults + +`func NewDataLakeCloudProviderConfigWithDefaults() *DataLakeCloudProviderConfig` + +NewDataLakeCloudProviderConfigWithDefaults instantiates a new DataLakeCloudProviderConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAws + +`func (o *DataLakeCloudProviderConfig) GetAws() DataLakeAWSCloudProviderConfig` + +GetAws returns the Aws field if non-nil, zero value otherwise. + +### GetAwsOk + +`func (o *DataLakeCloudProviderConfig) GetAwsOk() (*DataLakeAWSCloudProviderConfig, bool)` + +GetAwsOk returns a tuple with the Aws field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAws + +`func (o *DataLakeCloudProviderConfig) SetAws(v DataLakeAWSCloudProviderConfig)` + +SetAws sets Aws field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeDataProcessRegion.md b/docs/docs/DataLakeDataProcessRegion.md new file mode 100644 index 00000000..d13e708c --- /dev/null +++ b/docs/docs/DataLakeDataProcessRegion.md @@ -0,0 +1,72 @@ +# DataLakeDataProcessRegion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProvider** | **string** | Name of the cloud service that hosts the data lake's data stores. | +**Region** | [**DataLakeRegion**](DataLakeRegion.md) | | + +## Methods + +### NewDataLakeDataProcessRegion + +`func NewDataLakeDataProcessRegion(cloudProvider string, region DataLakeRegion, ) *DataLakeDataProcessRegion` + +NewDataLakeDataProcessRegion instantiates a new DataLakeDataProcessRegion object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeDataProcessRegionWithDefaults + +`func NewDataLakeDataProcessRegionWithDefaults() *DataLakeDataProcessRegion` + +NewDataLakeDataProcessRegionWithDefaults instantiates a new DataLakeDataProcessRegion object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProvider + +`func (o *DataLakeDataProcessRegion) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *DataLakeDataProcessRegion) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *DataLakeDataProcessRegion) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + + +### GetRegion + +`func (o *DataLakeDataProcessRegion) GetRegion() DataLakeRegion` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *DataLakeDataProcessRegion) GetRegionOk() (*DataLakeRegion, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *DataLakeDataProcessRegion) SetRegion(v DataLakeRegion)` + +SetRegion sets Region field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeDatabase.md b/docs/docs/DataLakeDatabase.md new file mode 100644 index 00000000..cc87ce16 --- /dev/null +++ b/docs/docs/DataLakeDatabase.md @@ -0,0 +1,134 @@ +# DataLakeDatabase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Collections** | Pointer to [**[]DataLakeDatabaseCollection**](DataLakeDatabaseCollection.md) | Array of collections and data sources that map to a ``stores`` data store. | [optional] +**MaxWildcardCollections** | Pointer to **int** | Maximum number of wildcard collections in the database. This only applies to S3 data sources. | [optional] [default to 100] +**Name** | Pointer to **string** | Human-readable label that identifies the database to which the data lake maps data. | [optional] +**Views** | Pointer to [**[]DataLakeView**](DataLakeView.md) | Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources. | [optional] + +## Methods + +### NewDataLakeDatabase + +`func NewDataLakeDatabase() *DataLakeDatabase` + +NewDataLakeDatabase instantiates a new DataLakeDatabase object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeDatabaseWithDefaults + +`func NewDataLakeDatabaseWithDefaults() *DataLakeDatabase` + +NewDataLakeDatabaseWithDefaults instantiates a new DataLakeDatabase object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCollections + +`func (o *DataLakeDatabase) GetCollections() []DataLakeDatabaseCollection` + +GetCollections returns the Collections field if non-nil, zero value otherwise. + +### GetCollectionsOk + +`func (o *DataLakeDatabase) GetCollectionsOk() (*[]DataLakeDatabaseCollection, bool)` + +GetCollectionsOk returns a tuple with the Collections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollections + +`func (o *DataLakeDatabase) SetCollections(v []DataLakeDatabaseCollection)` + +SetCollections sets Collections field to given value. + +### HasCollections + +`func (o *DataLakeDatabase) HasCollections() bool` + +HasCollections returns a boolean if a field has been set. + +### GetMaxWildcardCollections + +`func (o *DataLakeDatabase) GetMaxWildcardCollections() int` + +GetMaxWildcardCollections returns the MaxWildcardCollections field if non-nil, zero value otherwise. + +### GetMaxWildcardCollectionsOk + +`func (o *DataLakeDatabase) GetMaxWildcardCollectionsOk() (*int, bool)` + +GetMaxWildcardCollectionsOk returns a tuple with the MaxWildcardCollections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxWildcardCollections + +`func (o *DataLakeDatabase) SetMaxWildcardCollections(v int)` + +SetMaxWildcardCollections sets MaxWildcardCollections field to given value. + +### HasMaxWildcardCollections + +`func (o *DataLakeDatabase) HasMaxWildcardCollections() bool` + +HasMaxWildcardCollections returns a boolean if a field has been set. + +### GetName + +`func (o *DataLakeDatabase) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeDatabase) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeDatabase) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeDatabase) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetViews + +`func (o *DataLakeDatabase) GetViews() []DataLakeView` + +GetViews returns the Views field if non-nil, zero value otherwise. + +### GetViewsOk + +`func (o *DataLakeDatabase) GetViewsOk() (*[]DataLakeView, bool)` + +GetViewsOk returns a tuple with the Views field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViews + +`func (o *DataLakeDatabase) SetViews(v []DataLakeView)` + +SetViews sets Views field to given value. + +### HasViews + +`func (o *DataLakeDatabase) HasViews() bool` + +HasViews returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeDatabaseCollection.md b/docs/docs/DataLakeDatabaseCollection.md new file mode 100644 index 00000000..d3494d5d --- /dev/null +++ b/docs/docs/DataLakeDatabaseCollection.md @@ -0,0 +1,82 @@ +# DataLakeDatabaseCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataSources** | Pointer to [**[]DataLakeDatabaseDataSource**](DataLakeDatabaseDataSource.md) | Array that contains the data stores that map to a collection for this data lake. | [optional] +**Name** | Pointer to **string** | Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores. | [optional] + +## Methods + +### NewDataLakeDatabaseCollection + +`func NewDataLakeDatabaseCollection() *DataLakeDatabaseCollection` + +NewDataLakeDatabaseCollection instantiates a new DataLakeDatabaseCollection object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeDatabaseCollectionWithDefaults + +`func NewDataLakeDatabaseCollectionWithDefaults() *DataLakeDatabaseCollection` + +NewDataLakeDatabaseCollectionWithDefaults instantiates a new DataLakeDatabaseCollection object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDataSources + +`func (o *DataLakeDatabaseCollection) GetDataSources() []DataLakeDatabaseDataSource` + +GetDataSources returns the DataSources field if non-nil, zero value otherwise. + +### GetDataSourcesOk + +`func (o *DataLakeDatabaseCollection) GetDataSourcesOk() (*[]DataLakeDatabaseDataSource, bool)` + +GetDataSourcesOk returns a tuple with the DataSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSources + +`func (o *DataLakeDatabaseCollection) SetDataSources(v []DataLakeDatabaseDataSource)` + +SetDataSources sets DataSources field to given value. + +### HasDataSources + +`func (o *DataLakeDatabaseCollection) HasDataSources() bool` + +HasDataSources returns a boolean if a field has been set. + +### GetName + +`func (o *DataLakeDatabaseCollection) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeDatabaseCollection) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeDatabaseCollection) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeDatabaseCollection) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeDatabaseDataSource.md b/docs/docs/DataLakeDatabaseDataSource.md new file mode 100644 index 00000000..60456b1a --- /dev/null +++ b/docs/docs/DataLakeDatabaseDataSource.md @@ -0,0 +1,290 @@ +# DataLakeDatabaseDataSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowInsecure** | Pointer to **bool** | Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only. | [optional] [default to false] +**Collection** | Pointer to **string** | Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter. | [optional] +**CollectionRegex** | Pointer to **string** | Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp). | [optional] +**Database** | Pointer to **string** | Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases. | [optional] +**DatabaseRegex** | Pointer to **string** | Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp). | [optional] +**DefaultFormat** | Pointer to **string** | File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**. | [optional] +**Path** | Pointer to **string** | File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path. | [optional] +**ProvenanceFieldName** | Pointer to **string** | Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider. | [optional] +**StoreName** | Pointer to **string** | Human-readable label that identifies the data store that MongoDB Cloud maps to the collection. | [optional] +**Urls** | Pointer to **[]string** | URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter. | [optional] + +## Methods + +### NewDataLakeDatabaseDataSource + +`func NewDataLakeDatabaseDataSource() *DataLakeDatabaseDataSource` + +NewDataLakeDatabaseDataSource instantiates a new DataLakeDatabaseDataSource object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeDatabaseDataSourceWithDefaults + +`func NewDataLakeDatabaseDataSourceWithDefaults() *DataLakeDatabaseDataSource` + +NewDataLakeDatabaseDataSourceWithDefaults instantiates a new DataLakeDatabaseDataSource object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAllowInsecure + +`func (o *DataLakeDatabaseDataSource) GetAllowInsecure() bool` + +GetAllowInsecure returns the AllowInsecure field if non-nil, zero value otherwise. + +### GetAllowInsecureOk + +`func (o *DataLakeDatabaseDataSource) GetAllowInsecureOk() (*bool, bool)` + +GetAllowInsecureOk returns a tuple with the AllowInsecure field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowInsecure + +`func (o *DataLakeDatabaseDataSource) SetAllowInsecure(v bool)` + +SetAllowInsecure sets AllowInsecure field to given value. + +### HasAllowInsecure + +`func (o *DataLakeDatabaseDataSource) HasAllowInsecure() bool` + +HasAllowInsecure returns a boolean if a field has been set. + +### GetCollection + +`func (o *DataLakeDatabaseDataSource) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *DataLakeDatabaseDataSource) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *DataLakeDatabaseDataSource) SetCollection(v string)` + +SetCollection sets Collection field to given value. + +### HasCollection + +`func (o *DataLakeDatabaseDataSource) HasCollection() bool` + +HasCollection returns a boolean if a field has been set. + +### GetCollectionRegex + +`func (o *DataLakeDatabaseDataSource) GetCollectionRegex() string` + +GetCollectionRegex returns the CollectionRegex field if non-nil, zero value otherwise. + +### GetCollectionRegexOk + +`func (o *DataLakeDatabaseDataSource) GetCollectionRegexOk() (*string, bool)` + +GetCollectionRegexOk returns a tuple with the CollectionRegex field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionRegex + +`func (o *DataLakeDatabaseDataSource) SetCollectionRegex(v string)` + +SetCollectionRegex sets CollectionRegex field to given value. + +### HasCollectionRegex + +`func (o *DataLakeDatabaseDataSource) HasCollectionRegex() bool` + +HasCollectionRegex returns a boolean if a field has been set. + +### GetDatabase + +`func (o *DataLakeDatabaseDataSource) GetDatabase() string` + +GetDatabase returns the Database field if non-nil, zero value otherwise. + +### GetDatabaseOk + +`func (o *DataLakeDatabaseDataSource) GetDatabaseOk() (*string, bool)` + +GetDatabaseOk returns a tuple with the Database field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabase + +`func (o *DataLakeDatabaseDataSource) SetDatabase(v string)` + +SetDatabase sets Database field to given value. + +### HasDatabase + +`func (o *DataLakeDatabaseDataSource) HasDatabase() bool` + +HasDatabase returns a boolean if a field has been set. + +### GetDatabaseRegex + +`func (o *DataLakeDatabaseDataSource) GetDatabaseRegex() string` + +GetDatabaseRegex returns the DatabaseRegex field if non-nil, zero value otherwise. + +### GetDatabaseRegexOk + +`func (o *DataLakeDatabaseDataSource) GetDatabaseRegexOk() (*string, bool)` + +GetDatabaseRegexOk returns a tuple with the DatabaseRegex field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseRegex + +`func (o *DataLakeDatabaseDataSource) SetDatabaseRegex(v string)` + +SetDatabaseRegex sets DatabaseRegex field to given value. + +### HasDatabaseRegex + +`func (o *DataLakeDatabaseDataSource) HasDatabaseRegex() bool` + +HasDatabaseRegex returns a boolean if a field has been set. + +### GetDefaultFormat + +`func (o *DataLakeDatabaseDataSource) GetDefaultFormat() string` + +GetDefaultFormat returns the DefaultFormat field if non-nil, zero value otherwise. + +### GetDefaultFormatOk + +`func (o *DataLakeDatabaseDataSource) GetDefaultFormatOk() (*string, bool)` + +GetDefaultFormatOk returns a tuple with the DefaultFormat field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultFormat + +`func (o *DataLakeDatabaseDataSource) SetDefaultFormat(v string)` + +SetDefaultFormat sets DefaultFormat field to given value. + +### HasDefaultFormat + +`func (o *DataLakeDatabaseDataSource) HasDefaultFormat() bool` + +HasDefaultFormat returns a boolean if a field has been set. + +### GetPath + +`func (o *DataLakeDatabaseDataSource) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *DataLakeDatabaseDataSource) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *DataLakeDatabaseDataSource) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *DataLakeDatabaseDataSource) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetProvenanceFieldName + +`func (o *DataLakeDatabaseDataSource) GetProvenanceFieldName() string` + +GetProvenanceFieldName returns the ProvenanceFieldName field if non-nil, zero value otherwise. + +### GetProvenanceFieldNameOk + +`func (o *DataLakeDatabaseDataSource) GetProvenanceFieldNameOk() (*string, bool)` + +GetProvenanceFieldNameOk returns a tuple with the ProvenanceFieldName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvenanceFieldName + +`func (o *DataLakeDatabaseDataSource) SetProvenanceFieldName(v string)` + +SetProvenanceFieldName sets ProvenanceFieldName field to given value. + +### HasProvenanceFieldName + +`func (o *DataLakeDatabaseDataSource) HasProvenanceFieldName() bool` + +HasProvenanceFieldName returns a boolean if a field has been set. + +### GetStoreName + +`func (o *DataLakeDatabaseDataSource) GetStoreName() string` + +GetStoreName returns the StoreName field if non-nil, zero value otherwise. + +### GetStoreNameOk + +`func (o *DataLakeDatabaseDataSource) GetStoreNameOk() (*string, bool)` + +GetStoreNameOk returns a tuple with the StoreName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStoreName + +`func (o *DataLakeDatabaseDataSource) SetStoreName(v string)` + +SetStoreName sets StoreName field to given value. + +### HasStoreName + +`func (o *DataLakeDatabaseDataSource) HasStoreName() bool` + +HasStoreName returns a boolean if a field has been set. + +### GetUrls + +`func (o *DataLakeDatabaseDataSource) GetUrls() []string` + +GetUrls returns the Urls field if non-nil, zero value otherwise. + +### GetUrlsOk + +`func (o *DataLakeDatabaseDataSource) GetUrlsOk() (*[]string, bool)` + +GetUrlsOk returns a tuple with the Urls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrls + +`func (o *DataLakeDatabaseDataSource) SetUrls(v []string)` + +SetUrls sets Urls field to given value. + +### HasUrls + +`func (o *DataLakeDatabaseDataSource) HasUrls() bool` + +HasUrls returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeHTTPStore.md b/docs/docs/DataLakeHTTPStore.md new file mode 100644 index 00000000..c0dc4bce --- /dev/null +++ b/docs/docs/DataLakeHTTPStore.md @@ -0,0 +1,155 @@ +# DataLakeHTTPStore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowInsecure** | Pointer to **bool** | Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only. | [optional] [default to false] +**DefaultFormat** | Pointer to **string** | Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object. | [optional] +**Urls** | Pointer to **[]string** | Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication. | [optional] +**Name** | Pointer to **string** | Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster. | [optional] +**Provider** | **string** | | + +## Methods + +### NewDataLakeHTTPStore + +`func NewDataLakeHTTPStore(provider string, ) *DataLakeHTTPStore` + +NewDataLakeHTTPStore instantiates a new DataLakeHTTPStore object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeHTTPStoreWithDefaults + +`func NewDataLakeHTTPStoreWithDefaults() *DataLakeHTTPStore` + +NewDataLakeHTTPStoreWithDefaults instantiates a new DataLakeHTTPStore object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAllowInsecure + +`func (o *DataLakeHTTPStore) GetAllowInsecure() bool` + +GetAllowInsecure returns the AllowInsecure field if non-nil, zero value otherwise. + +### GetAllowInsecureOk + +`func (o *DataLakeHTTPStore) GetAllowInsecureOk() (*bool, bool)` + +GetAllowInsecureOk returns a tuple with the AllowInsecure field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowInsecure + +`func (o *DataLakeHTTPStore) SetAllowInsecure(v bool)` + +SetAllowInsecure sets AllowInsecure field to given value. + +### HasAllowInsecure + +`func (o *DataLakeHTTPStore) HasAllowInsecure() bool` + +HasAllowInsecure returns a boolean if a field has been set. + +### GetDefaultFormat + +`func (o *DataLakeHTTPStore) GetDefaultFormat() string` + +GetDefaultFormat returns the DefaultFormat field if non-nil, zero value otherwise. + +### GetDefaultFormatOk + +`func (o *DataLakeHTTPStore) GetDefaultFormatOk() (*string, bool)` + +GetDefaultFormatOk returns a tuple with the DefaultFormat field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultFormat + +`func (o *DataLakeHTTPStore) SetDefaultFormat(v string)` + +SetDefaultFormat sets DefaultFormat field to given value. + +### HasDefaultFormat + +`func (o *DataLakeHTTPStore) HasDefaultFormat() bool` + +HasDefaultFormat returns a boolean if a field has been set. + +### GetUrls + +`func (o *DataLakeHTTPStore) GetUrls() []string` + +GetUrls returns the Urls field if non-nil, zero value otherwise. + +### GetUrlsOk + +`func (o *DataLakeHTTPStore) GetUrlsOk() (*[]string, bool)` + +GetUrlsOk returns a tuple with the Urls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrls + +`func (o *DataLakeHTTPStore) SetUrls(v []string)` + +SetUrls sets Urls field to given value. + +### HasUrls + +`func (o *DataLakeHTTPStore) HasUrls() bool` + +HasUrls returns a boolean if a field has been set. + +### GetName + +`func (o *DataLakeHTTPStore) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeHTTPStore) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeHTTPStore) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeHTTPStore) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvider + +`func (o *DataLakeHTTPStore) GetProvider() string` + +GetProvider returns the Provider field if non-nil, zero value otherwise. + +### GetProviderOk + +`func (o *DataLakeHTTPStore) GetProviderOk() (*string, bool)` + +GetProviderOk returns a tuple with the Provider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvider + +`func (o *DataLakeHTTPStore) SetProvider(v string)` + +SetProvider sets Provider field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeOnlineArchiveStore.md b/docs/docs/DataLakeOnlineArchiveStore.md new file mode 100644 index 00000000..c9186c90 --- /dev/null +++ b/docs/docs/DataLakeOnlineArchiveStore.md @@ -0,0 +1,140 @@ +# DataLakeOnlineArchiveStore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | **string** | ID of the Cluster the Online Archive belongs to. | +**ClusterName** | **string** | Name of the Cluster the Online Archive belongs to. | +**ProjectId** | **string** | ID of the Project the Online Archive belongs to. | +**Name** | Pointer to **string** | Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster. | [optional] +**Provider** | **string** | | + +## Methods + +### NewDataLakeOnlineArchiveStore + +`func NewDataLakeOnlineArchiveStore(clusterId string, clusterName string, projectId string, provider string, ) *DataLakeOnlineArchiveStore` + +NewDataLakeOnlineArchiveStore instantiates a new DataLakeOnlineArchiveStore object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeOnlineArchiveStoreWithDefaults + +`func NewDataLakeOnlineArchiveStoreWithDefaults() *DataLakeOnlineArchiveStore` + +NewDataLakeOnlineArchiveStoreWithDefaults instantiates a new DataLakeOnlineArchiveStore object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterId + +`func (o *DataLakeOnlineArchiveStore) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *DataLakeOnlineArchiveStore) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *DataLakeOnlineArchiveStore) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetClusterName + +`func (o *DataLakeOnlineArchiveStore) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *DataLakeOnlineArchiveStore) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *DataLakeOnlineArchiveStore) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + + +### GetProjectId + +`func (o *DataLakeOnlineArchiveStore) GetProjectId() string` + +GetProjectId returns the ProjectId field if non-nil, zero value otherwise. + +### GetProjectIdOk + +`func (o *DataLakeOnlineArchiveStore) GetProjectIdOk() (*string, bool)` + +GetProjectIdOk returns a tuple with the ProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProjectId + +`func (o *DataLakeOnlineArchiveStore) SetProjectId(v string)` + +SetProjectId sets ProjectId field to given value. + + +### GetName + +`func (o *DataLakeOnlineArchiveStore) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeOnlineArchiveStore) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeOnlineArchiveStore) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeOnlineArchiveStore) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvider + +`func (o *DataLakeOnlineArchiveStore) GetProvider() string` + +GetProvider returns the Provider field if non-nil, zero value otherwise. + +### GetProviderOk + +`func (o *DataLakeOnlineArchiveStore) GetProviderOk() (*string, bool)` + +GetProviderOk returns a tuple with the Provider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvider + +`func (o *DataLakeOnlineArchiveStore) SetProvider(v string)` + +SetProvider sets Provider field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakePipelinesApi.md b/docs/docs/DataLakePipelinesApi.md new file mode 100644 index 00000000..fb655552 --- /dev/null +++ b/docs/docs/DataLakePipelinesApi.md @@ -0,0 +1,1040 @@ +# \DataLakePipelinesApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreatePipeline**](DataLakePipelinesApi.md#CreatePipeline) | **Post** /api/atlas/v2/groups/{groupId}/pipelines | Create One Data Lake Pipeline +[**DeletePipeline**](DataLakePipelinesApi.md#DeletePipeline) | **Delete** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName} | Remove One Data Lake Pipeline +[**DeletePipelineRunDataset**](DataLakePipelinesApi.md#DeletePipelineRunDataset) | **Delete** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId} | Delete Pipeline Run Dataset +[**GetPipeline**](DataLakePipelinesApi.md#GetPipeline) | **Get** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName} | Return One Data Lake Pipeline +[**GetPipelineRun**](DataLakePipelinesApi.md#GetPipelineRun) | **Get** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId} | Return One Data Lake Pipeline Run +[**ListPipelineRuns**](DataLakePipelinesApi.md#ListPipelineRuns) | **Get** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs | Return All Data Lake Pipeline Runs from One Project +[**ListPipelineSchedules**](DataLakePipelinesApi.md#ListPipelineSchedules) | **Get** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules | Return Available Ingestion Schedules for One Data Lake Pipeline +[**ListPipelineSnapshots**](DataLakePipelinesApi.md#ListPipelineSnapshots) | **Get** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots | Return Available Backup Snapshots for One Data Lake Pipeline +[**ListPipelines**](DataLakePipelinesApi.md#ListPipelines) | **Get** /api/atlas/v2/groups/{groupId}/pipelines | Return All Data Lake Pipelines from One Project +[**PausePipeline**](DataLakePipelinesApi.md#PausePipeline) | **Post** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause | Pause One Data Lake Pipeline +[**ResumePipeline**](DataLakePipelinesApi.md#ResumePipeline) | **Post** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume | Resume One Data Lake Pipeline +[**TriggerSnapshotIngestion**](DataLakePipelinesApi.md#TriggerSnapshotIngestion) | **Post** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger | Trigger on demand snapshot ingestion +[**UpdatePipeline**](DataLakePipelinesApi.md#UpdatePipeline) | **Patch** /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName} | Update One Data Lake Pipeline + + + +## CreatePipeline + +> IngestionPipeline CreatePipeline(ctx, groupId).IngestionPipeline(ingestionPipeline).Execute() + +Create One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + ingestionPipeline := *openapiclient.NewIngestionPipeline() // IngestionPipeline | + + resp, r, err := sdk.DataLakePipelinesApi.CreatePipeline(context.Background(), groupId).IngestionPipeline(ingestionPipeline).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.CreatePipeline``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreatePipeline`: IngestionPipeline + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.CreatePipeline`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePipelineRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **ingestionPipeline** | [**IngestionPipeline**](IngestionPipeline.md) | Creates one Data Lake Pipeline. | + +### Return type + +[**IngestionPipeline**](IngestionPipeline.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePipeline + +> DeletePipeline(ctx, groupId, pipelineName).Execute() + +Remove One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + + r, err := sdk.DataLakePipelinesApi.DeletePipeline(context.Background(), groupId, pipelineName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.DeletePipeline``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePipelineRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePipelineRunDataset + +> DeletePipelineRunDataset(ctx, groupId, pipelineName, pipelineRunId).Execute() + +Delete Pipeline Run Dataset + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + pipelineRunId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.DataLakePipelinesApi.DeletePipelineRunDataset(context.Background(), groupId, pipelineName, pipelineRunId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.DeletePipelineRunDataset``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | +**pipelineRunId** | **string** | Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePipelineRunDatasetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPipeline + +> IngestionPipeline GetPipeline(ctx, groupId, pipelineName).Execute() + +Return One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + + resp, r, err := sdk.DataLakePipelinesApi.GetPipeline(context.Background(), groupId, pipelineName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.GetPipeline``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetPipeline`: IngestionPipeline + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.GetPipeline`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPipelineRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**IngestionPipeline**](IngestionPipeline.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPipelineRun + +> IngestionPipelineRun GetPipelineRun(ctx, groupId, pipelineName, pipelineRunId).Execute() + +Return One Data Lake Pipeline Run + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + pipelineRunId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.DataLakePipelinesApi.GetPipelineRun(context.Background(), groupId, pipelineName, pipelineRunId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.GetPipelineRun``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetPipelineRun`: IngestionPipelineRun + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.GetPipelineRun`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | +**pipelineRunId** | **string** | Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPipelineRunRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**IngestionPipelineRun**](IngestionPipelineRun.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPipelineRuns + +> PaginatedPipelineRun ListPipelineRuns(ctx, groupId, pipelineName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).CreatedBefore(createdBefore).Execute() + +Return All Data Lake Pipeline Runs from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + createdBefore := time.Now() // time.Time | (optional) + + resp, r, err := sdk.DataLakePipelinesApi.ListPipelineRuns(context.Background(), groupId, pipelineName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).CreatedBefore(createdBefore).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.ListPipelineRuns``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPipelineRuns`: PaginatedPipelineRun + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.ListPipelineRuns`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPipelineRunsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **createdBefore** | **time.Time** | If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date. | + +### Return type + +[**PaginatedPipelineRun**](PaginatedPipelineRun.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPipelineSchedules + +> []PolicyItem ListPipelineSchedules(ctx, groupId, pipelineName).Execute() + +Return Available Ingestion Schedules for One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + + resp, r, err := sdk.DataLakePipelinesApi.ListPipelineSchedules(context.Background(), groupId, pipelineName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.ListPipelineSchedules``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPipelineSchedules`: []PolicyItem + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.ListPipelineSchedules`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPipelineSchedulesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**[]PolicyItem**](PolicyItem.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPipelineSnapshots + +> PaginatedBackupSnapshot ListPipelineSnapshots(ctx, groupId, pipelineName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).CompletedAfter(completedAfter).Execute() + +Return Available Backup Snapshots for One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + completedAfter := time.Now() // time.Time | (optional) + + resp, r, err := sdk.DataLakePipelinesApi.ListPipelineSnapshots(context.Background(), groupId, pipelineName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).CompletedAfter(completedAfter).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.ListPipelineSnapshots``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPipelineSnapshots`: PaginatedBackupSnapshot + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.ListPipelineSnapshots`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPipelineSnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **completedAfter** | **time.Time** | Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | + +### Return type + +[**PaginatedBackupSnapshot**](PaginatedBackupSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPipelines + +> []IngestionPipeline ListPipelines(ctx, groupId).Execute() + +Return All Data Lake Pipelines from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.DataLakePipelinesApi.ListPipelines(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.ListPipelines``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPipelines`: []IngestionPipeline + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.ListPipelines`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPipelinesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]IngestionPipeline**](IngestionPipeline.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PausePipeline + +> IngestionPipeline PausePipeline(ctx, groupId, pipelineName).Execute() + +Pause One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + + resp, r, err := sdk.DataLakePipelinesApi.PausePipeline(context.Background(), groupId, pipelineName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.PausePipeline``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `PausePipeline`: IngestionPipeline + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.PausePipeline`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPausePipelineRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**IngestionPipeline**](IngestionPipeline.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ResumePipeline + +> IngestionPipeline ResumePipeline(ctx, groupId, pipelineName).Execute() + +Resume One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + + resp, r, err := sdk.DataLakePipelinesApi.ResumePipeline(context.Background(), groupId, pipelineName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.ResumePipeline``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ResumePipeline`: IngestionPipeline + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.ResumePipeline`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResumePipelineRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**IngestionPipeline**](IngestionPipeline.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TriggerSnapshotIngestion + +> IngestionPipelineRun TriggerSnapshotIngestion(ctx, groupId, pipelineName).TriggerIngestionRequest(triggerIngestionRequest).Execute() + +Trigger on demand snapshot ingestion + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + triggerIngestionRequest := *openapiclient.NewTriggerIngestionRequest("32b6e34b3d91647abb20e7b8") // TriggerIngestionRequest | + + resp, r, err := sdk.DataLakePipelinesApi.TriggerSnapshotIngestion(context.Background(), groupId, pipelineName).TriggerIngestionRequest(triggerIngestionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.TriggerSnapshotIngestion``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `TriggerSnapshotIngestion`: IngestionPipelineRun + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.TriggerSnapshotIngestion`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTriggerSnapshotIngestionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **triggerIngestionRequest** | [**TriggerIngestionRequest**](TriggerIngestionRequest.md) | Triggers a single ingestion run of a snapshot. | + +### Return type + +[**IngestionPipelineRun**](IngestionPipelineRun.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdatePipeline + +> IngestionPipeline UpdatePipeline(ctx, groupId, pipelineName).IngestionPipeline(ingestionPipeline).Execute() + +Update One Data Lake Pipeline + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + pipelineName := "pipelineName_example" // string | + ingestionPipeline := *openapiclient.NewIngestionPipeline() // IngestionPipeline | + + resp, r, err := sdk.DataLakePipelinesApi.UpdatePipeline(context.Background(), groupId, pipelineName).IngestionPipeline(ingestionPipeline).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataLakePipelinesApi.UpdatePipeline``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdatePipeline`: IngestionPipeline + fmt.Fprintf(os.Stdout, "Response from `DataLakePipelinesApi.UpdatePipeline`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**pipelineName** | **string** | Human-readable label that identifies the Data Lake Pipeline. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePipelineRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **ingestionPipeline** | [**IngestionPipeline**](IngestionPipeline.md) | Updates one Data Lake Pipeline. | + +### Return type + +[**IngestionPipeline**](IngestionPipeline.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/DataLakeRegion.md b/docs/docs/DataLakeRegion.md new file mode 100644 index 00000000..3cbd4cd4 --- /dev/null +++ b/docs/docs/DataLakeRegion.md @@ -0,0 +1,27 @@ +# DataLakeRegion + +## Enum + + +* `SYDNEY_AUS` (value: `"SYDNEY_AUS"`) + +* `MUMBAI_IND` (value: `"MUMBAI_IND"`) + +* `FRANKFURT_DEU` (value: `"FRANKFURT_DEU"`) + +* `DUBLIN_IRL` (value: `"DUBLIN_IRL"`) + +* `LONDON_GBR` (value: `"LONDON_GBR"`) + +* `VIRGINIA_USA` (value: `"VIRGINIA_USA"`) + +* `OREGON_USA` (value: `"OREGON_USA"`) + +* `SAOPAULO_BRA` (value: `"SAOPAULO_BRA"`) + +* `SINGAPORE_SGP` (value: `"SINGAPORE_SGP"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeS3Store.md b/docs/docs/DataLakeS3Store.md new file mode 100644 index 00000000..b435f435 --- /dev/null +++ b/docs/docs/DataLakeS3Store.md @@ -0,0 +1,259 @@ +# DataLakeS3Store + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdditionalStorageClasses** | Pointer to **[]string** | Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results. | [optional] +**Bucket** | Pointer to **string** | Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials. | [optional] +**Delimiter** | Pointer to **string** | The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`. | [optional] +**IncludeTags** | Pointer to **bool** | Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document. | [optional] [default to false] +**Prefix** | Pointer to **string** | Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket. | [optional] +**Public** | Pointer to **bool** | Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket. | [optional] [default to false] +**Region** | Pointer to **string** | Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. | [optional] +**Name** | Pointer to **string** | Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster. | [optional] +**Provider** | **string** | | + +## Methods + +### NewDataLakeS3Store + +`func NewDataLakeS3Store(provider string, ) *DataLakeS3Store` + +NewDataLakeS3Store instantiates a new DataLakeS3Store object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeS3StoreWithDefaults + +`func NewDataLakeS3StoreWithDefaults() *DataLakeS3Store` + +NewDataLakeS3StoreWithDefaults instantiates a new DataLakeS3Store object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAdditionalStorageClasses + +`func (o *DataLakeS3Store) GetAdditionalStorageClasses() []string` + +GetAdditionalStorageClasses returns the AdditionalStorageClasses field if non-nil, zero value otherwise. + +### GetAdditionalStorageClassesOk + +`func (o *DataLakeS3Store) GetAdditionalStorageClassesOk() (*[]string, bool)` + +GetAdditionalStorageClassesOk returns a tuple with the AdditionalStorageClasses field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdditionalStorageClasses + +`func (o *DataLakeS3Store) SetAdditionalStorageClasses(v []string)` + +SetAdditionalStorageClasses sets AdditionalStorageClasses field to given value. + +### HasAdditionalStorageClasses + +`func (o *DataLakeS3Store) HasAdditionalStorageClasses() bool` + +HasAdditionalStorageClasses returns a boolean if a field has been set. + +### GetBucket + +`func (o *DataLakeS3Store) GetBucket() string` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *DataLakeS3Store) GetBucketOk() (*string, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *DataLakeS3Store) SetBucket(v string)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *DataLakeS3Store) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetDelimiter + +`func (o *DataLakeS3Store) GetDelimiter() string` + +GetDelimiter returns the Delimiter field if non-nil, zero value otherwise. + +### GetDelimiterOk + +`func (o *DataLakeS3Store) GetDelimiterOk() (*string, bool)` + +GetDelimiterOk returns a tuple with the Delimiter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelimiter + +`func (o *DataLakeS3Store) SetDelimiter(v string)` + +SetDelimiter sets Delimiter field to given value. + +### HasDelimiter + +`func (o *DataLakeS3Store) HasDelimiter() bool` + +HasDelimiter returns a boolean if a field has been set. + +### GetIncludeTags + +`func (o *DataLakeS3Store) GetIncludeTags() bool` + +GetIncludeTags returns the IncludeTags field if non-nil, zero value otherwise. + +### GetIncludeTagsOk + +`func (o *DataLakeS3Store) GetIncludeTagsOk() (*bool, bool)` + +GetIncludeTagsOk returns a tuple with the IncludeTags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTags + +`func (o *DataLakeS3Store) SetIncludeTags(v bool)` + +SetIncludeTags sets IncludeTags field to given value. + +### HasIncludeTags + +`func (o *DataLakeS3Store) HasIncludeTags() bool` + +HasIncludeTags returns a boolean if a field has been set. + +### GetPrefix + +`func (o *DataLakeS3Store) GetPrefix() string` + +GetPrefix returns the Prefix field if non-nil, zero value otherwise. + +### GetPrefixOk + +`func (o *DataLakeS3Store) GetPrefixOk() (*string, bool)` + +GetPrefixOk returns a tuple with the Prefix field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrefix + +`func (o *DataLakeS3Store) SetPrefix(v string)` + +SetPrefix sets Prefix field to given value. + +### HasPrefix + +`func (o *DataLakeS3Store) HasPrefix() bool` + +HasPrefix returns a boolean if a field has been set. + +### GetPublic + +`func (o *DataLakeS3Store) GetPublic() bool` + +GetPublic returns the Public field if non-nil, zero value otherwise. + +### GetPublicOk + +`func (o *DataLakeS3Store) GetPublicOk() (*bool, bool)` + +GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublic + +`func (o *DataLakeS3Store) SetPublic(v bool)` + +SetPublic sets Public field to given value. + +### HasPublic + +`func (o *DataLakeS3Store) HasPublic() bool` + +HasPublic returns a boolean if a field has been set. + +### GetRegion + +`func (o *DataLakeS3Store) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *DataLakeS3Store) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *DataLakeS3Store) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *DataLakeS3Store) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetName + +`func (o *DataLakeS3Store) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeS3Store) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeS3Store) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeS3Store) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvider + +`func (o *DataLakeS3Store) GetProvider() string` + +GetProvider returns the Provider field if non-nil, zero value otherwise. + +### GetProviderOk + +`func (o *DataLakeS3Store) GetProviderOk() (*string, bool)` + +GetProviderOk returns a tuple with the Provider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvider + +`func (o *DataLakeS3Store) SetProvider(v string)` + +SetProvider sets Provider field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeStorage.md b/docs/docs/DataLakeStorage.md new file mode 100644 index 00000000..e906f8c2 --- /dev/null +++ b/docs/docs/DataLakeStorage.md @@ -0,0 +1,82 @@ +# DataLakeStorage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Databases** | Pointer to [**[]DataLakeDatabase**](DataLakeDatabase.md) | Array that contains the queryable databases and collections for this data lake. | [optional] +**Stores** | Pointer to [**[]DataLakeStore**](DataLakeStore.md) | Array that contains the data stores for the data lake. | [optional] + +## Methods + +### NewDataLakeStorage + +`func NewDataLakeStorage() *DataLakeStorage` + +NewDataLakeStorage instantiates a new DataLakeStorage object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeStorageWithDefaults + +`func NewDataLakeStorageWithDefaults() *DataLakeStorage` + +NewDataLakeStorageWithDefaults instantiates a new DataLakeStorage object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDatabases + +`func (o *DataLakeStorage) GetDatabases() []DataLakeDatabase` + +GetDatabases returns the Databases field if non-nil, zero value otherwise. + +### GetDatabasesOk + +`func (o *DataLakeStorage) GetDatabasesOk() (*[]DataLakeDatabase, bool)` + +GetDatabasesOk returns a tuple with the Databases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabases + +`func (o *DataLakeStorage) SetDatabases(v []DataLakeDatabase)` + +SetDatabases sets Databases field to given value. + +### HasDatabases + +`func (o *DataLakeStorage) HasDatabases() bool` + +HasDatabases returns a boolean if a field has been set. + +### GetStores + +`func (o *DataLakeStorage) GetStores() []DataLakeStore` + +GetStores returns the Stores field if non-nil, zero value otherwise. + +### GetStoresOk + +`func (o *DataLakeStorage) GetStoresOk() (*[]DataLakeStore, bool)` + +GetStoresOk returns a tuple with the Stores field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStores + +`func (o *DataLakeStorage) SetStores(v []DataLakeStore)` + +SetStores sets Stores field to given value. + +### HasStores + +`func (o *DataLakeStorage) HasStores() bool` + +HasStores returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeStore.md b/docs/docs/DataLakeStore.md new file mode 100644 index 00000000..0f66db3b --- /dev/null +++ b/docs/docs/DataLakeStore.md @@ -0,0 +1,426 @@ +# DataLakeStore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdditionalStorageClasses** | Pointer to **[]string** | Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results. | [optional] +**Bucket** | Pointer to **string** | Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials. | [optional] +**Delimiter** | Pointer to **string** | The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`. | [optional] +**IncludeTags** | Pointer to **bool** | Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document. | [optional] [default to false] +**Prefix** | Pointer to **string** | Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket. | [optional] +**Public** | Pointer to **bool** | Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket. | [optional] [default to false] +**Region** | Pointer to **string** | Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts. | [optional] +**Name** | Pointer to **string** | Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster. | [optional] +**Provider** | **string** | | +**ClusterId** | **string** | ID of the Cluster the Online Archive belongs to. | +**ClusterName** | **string** | Human-readable label of the MongoDB Cloud cluster on which the store is based. | +**ProjectId** | **string** | Unique 24-hexadecimal digit string that identifies the project. | [readonly] +**ReadPreference** | Pointer to [**DataLakeAtlasStoreReadPreference**](DataLakeAtlasStoreReadPreference.md) | | [optional] +**AllowInsecure** | Pointer to **bool** | Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only. | [optional] [default to false] +**DefaultFormat** | Pointer to **string** | Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object. | [optional] +**Urls** | Pointer to **[]string** | Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication. | [optional] + +## Methods + +### NewDataLakeStore + +`func NewDataLakeStore(provider string, clusterId string, clusterName string, projectId string, ) *DataLakeStore` + +NewDataLakeStore instantiates a new DataLakeStore object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeStoreWithDefaults + +`func NewDataLakeStoreWithDefaults() *DataLakeStore` + +NewDataLakeStoreWithDefaults instantiates a new DataLakeStore object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAdditionalStorageClasses + +`func (o *DataLakeStore) GetAdditionalStorageClasses() []string` + +GetAdditionalStorageClasses returns the AdditionalStorageClasses field if non-nil, zero value otherwise. + +### GetAdditionalStorageClassesOk + +`func (o *DataLakeStore) GetAdditionalStorageClassesOk() (*[]string, bool)` + +GetAdditionalStorageClassesOk returns a tuple with the AdditionalStorageClasses field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdditionalStorageClasses + +`func (o *DataLakeStore) SetAdditionalStorageClasses(v []string)` + +SetAdditionalStorageClasses sets AdditionalStorageClasses field to given value. + +### HasAdditionalStorageClasses + +`func (o *DataLakeStore) HasAdditionalStorageClasses() bool` + +HasAdditionalStorageClasses returns a boolean if a field has been set. + +### GetBucket + +`func (o *DataLakeStore) GetBucket() string` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *DataLakeStore) GetBucketOk() (*string, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *DataLakeStore) SetBucket(v string)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *DataLakeStore) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetDelimiter + +`func (o *DataLakeStore) GetDelimiter() string` + +GetDelimiter returns the Delimiter field if non-nil, zero value otherwise. + +### GetDelimiterOk + +`func (o *DataLakeStore) GetDelimiterOk() (*string, bool)` + +GetDelimiterOk returns a tuple with the Delimiter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelimiter + +`func (o *DataLakeStore) SetDelimiter(v string)` + +SetDelimiter sets Delimiter field to given value. + +### HasDelimiter + +`func (o *DataLakeStore) HasDelimiter() bool` + +HasDelimiter returns a boolean if a field has been set. + +### GetIncludeTags + +`func (o *DataLakeStore) GetIncludeTags() bool` + +GetIncludeTags returns the IncludeTags field if non-nil, zero value otherwise. + +### GetIncludeTagsOk + +`func (o *DataLakeStore) GetIncludeTagsOk() (*bool, bool)` + +GetIncludeTagsOk returns a tuple with the IncludeTags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTags + +`func (o *DataLakeStore) SetIncludeTags(v bool)` + +SetIncludeTags sets IncludeTags field to given value. + +### HasIncludeTags + +`func (o *DataLakeStore) HasIncludeTags() bool` + +HasIncludeTags returns a boolean if a field has been set. + +### GetPrefix + +`func (o *DataLakeStore) GetPrefix() string` + +GetPrefix returns the Prefix field if non-nil, zero value otherwise. + +### GetPrefixOk + +`func (o *DataLakeStore) GetPrefixOk() (*string, bool)` + +GetPrefixOk returns a tuple with the Prefix field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrefix + +`func (o *DataLakeStore) SetPrefix(v string)` + +SetPrefix sets Prefix field to given value. + +### HasPrefix + +`func (o *DataLakeStore) HasPrefix() bool` + +HasPrefix returns a boolean if a field has been set. + +### GetPublic + +`func (o *DataLakeStore) GetPublic() bool` + +GetPublic returns the Public field if non-nil, zero value otherwise. + +### GetPublicOk + +`func (o *DataLakeStore) GetPublicOk() (*bool, bool)` + +GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublic + +`func (o *DataLakeStore) SetPublic(v bool)` + +SetPublic sets Public field to given value. + +### HasPublic + +`func (o *DataLakeStore) HasPublic() bool` + +HasPublic returns a boolean if a field has been set. + +### GetRegion + +`func (o *DataLakeStore) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *DataLakeStore) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *DataLakeStore) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *DataLakeStore) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetName + +`func (o *DataLakeStore) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeStore) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeStore) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeStore) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvider + +`func (o *DataLakeStore) GetProvider() string` + +GetProvider returns the Provider field if non-nil, zero value otherwise. + +### GetProviderOk + +`func (o *DataLakeStore) GetProviderOk() (*string, bool)` + +GetProviderOk returns a tuple with the Provider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvider + +`func (o *DataLakeStore) SetProvider(v string)` + +SetProvider sets Provider field to given value. + + +### GetClusterId + +`func (o *DataLakeStore) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *DataLakeStore) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *DataLakeStore) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetClusterName + +`func (o *DataLakeStore) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *DataLakeStore) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *DataLakeStore) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + + +### GetProjectId + +`func (o *DataLakeStore) GetProjectId() string` + +GetProjectId returns the ProjectId field if non-nil, zero value otherwise. + +### GetProjectIdOk + +`func (o *DataLakeStore) GetProjectIdOk() (*string, bool)` + +GetProjectIdOk returns a tuple with the ProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProjectId + +`func (o *DataLakeStore) SetProjectId(v string)` + +SetProjectId sets ProjectId field to given value. + + +### GetReadPreference + +`func (o *DataLakeStore) GetReadPreference() DataLakeAtlasStoreReadPreference` + +GetReadPreference returns the ReadPreference field if non-nil, zero value otherwise. + +### GetReadPreferenceOk + +`func (o *DataLakeStore) GetReadPreferenceOk() (*DataLakeAtlasStoreReadPreference, bool)` + +GetReadPreferenceOk returns a tuple with the ReadPreference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadPreference + +`func (o *DataLakeStore) SetReadPreference(v DataLakeAtlasStoreReadPreference)` + +SetReadPreference sets ReadPreference field to given value. + +### HasReadPreference + +`func (o *DataLakeStore) HasReadPreference() bool` + +HasReadPreference returns a boolean if a field has been set. + +### GetAllowInsecure + +`func (o *DataLakeStore) GetAllowInsecure() bool` + +GetAllowInsecure returns the AllowInsecure field if non-nil, zero value otherwise. + +### GetAllowInsecureOk + +`func (o *DataLakeStore) GetAllowInsecureOk() (*bool, bool)` + +GetAllowInsecureOk returns a tuple with the AllowInsecure field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowInsecure + +`func (o *DataLakeStore) SetAllowInsecure(v bool)` + +SetAllowInsecure sets AllowInsecure field to given value. + +### HasAllowInsecure + +`func (o *DataLakeStore) HasAllowInsecure() bool` + +HasAllowInsecure returns a boolean if a field has been set. + +### GetDefaultFormat + +`func (o *DataLakeStore) GetDefaultFormat() string` + +GetDefaultFormat returns the DefaultFormat field if non-nil, zero value otherwise. + +### GetDefaultFormatOk + +`func (o *DataLakeStore) GetDefaultFormatOk() (*string, bool)` + +GetDefaultFormatOk returns a tuple with the DefaultFormat field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultFormat + +`func (o *DataLakeStore) SetDefaultFormat(v string)` + +SetDefaultFormat sets DefaultFormat field to given value. + +### HasDefaultFormat + +`func (o *DataLakeStore) HasDefaultFormat() bool` + +HasDefaultFormat returns a boolean if a field has been set. + +### GetUrls + +`func (o *DataLakeStore) GetUrls() []string` + +GetUrls returns the Urls field if non-nil, zero value otherwise. + +### GetUrlsOk + +`func (o *DataLakeStore) GetUrlsOk() (*[]string, bool)` + +GetUrlsOk returns a tuple with the Urls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrls + +`func (o *DataLakeStore) SetUrls(v []string)` + +SetUrls sets Urls field to given value. + +### HasUrls + +`func (o *DataLakeStore) HasUrls() bool` + +HasUrls returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeTenant.md b/docs/docs/DataLakeTenant.md new file mode 100644 index 00000000..a15132f7 --- /dev/null +++ b/docs/docs/DataLakeTenant.md @@ -0,0 +1,134 @@ +# DataLakeTenant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProviderConfig** | Pointer to [**DataLakeCloudProviderConfig**](DataLakeCloudProviderConfig.md) | | [optional] +**DataProcessRegion** | Pointer to [**DataLakeDataProcessRegion**](DataLakeDataProcessRegion.md) | | [optional] +**Name** | Pointer to **string** | Human-readable label that identifies the data lake. | [optional] +**Storage** | Pointer to [**DataLakeStorage**](DataLakeStorage.md) | | [optional] + +## Methods + +### NewDataLakeTenant + +`func NewDataLakeTenant() *DataLakeTenant` + +NewDataLakeTenant instantiates a new DataLakeTenant object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeTenantWithDefaults + +`func NewDataLakeTenantWithDefaults() *DataLakeTenant` + +NewDataLakeTenantWithDefaults instantiates a new DataLakeTenant object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProviderConfig + +`func (o *DataLakeTenant) GetCloudProviderConfig() DataLakeCloudProviderConfig` + +GetCloudProviderConfig returns the CloudProviderConfig field if non-nil, zero value otherwise. + +### GetCloudProviderConfigOk + +`func (o *DataLakeTenant) GetCloudProviderConfigOk() (*DataLakeCloudProviderConfig, bool)` + +GetCloudProviderConfigOk returns a tuple with the CloudProviderConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProviderConfig + +`func (o *DataLakeTenant) SetCloudProviderConfig(v DataLakeCloudProviderConfig)` + +SetCloudProviderConfig sets CloudProviderConfig field to given value. + +### HasCloudProviderConfig + +`func (o *DataLakeTenant) HasCloudProviderConfig() bool` + +HasCloudProviderConfig returns a boolean if a field has been set. + +### GetDataProcessRegion + +`func (o *DataLakeTenant) GetDataProcessRegion() DataLakeDataProcessRegion` + +GetDataProcessRegion returns the DataProcessRegion field if non-nil, zero value otherwise. + +### GetDataProcessRegionOk + +`func (o *DataLakeTenant) GetDataProcessRegionOk() (*DataLakeDataProcessRegion, bool)` + +GetDataProcessRegionOk returns a tuple with the DataProcessRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataProcessRegion + +`func (o *DataLakeTenant) SetDataProcessRegion(v DataLakeDataProcessRegion)` + +SetDataProcessRegion sets DataProcessRegion field to given value. + +### HasDataProcessRegion + +`func (o *DataLakeTenant) HasDataProcessRegion() bool` + +HasDataProcessRegion returns a boolean if a field has been set. + +### GetName + +`func (o *DataLakeTenant) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeTenant) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeTenant) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeTenant) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStorage + +`func (o *DataLakeTenant) GetStorage() DataLakeStorage` + +GetStorage returns the Storage field if non-nil, zero value otherwise. + +### GetStorageOk + +`func (o *DataLakeTenant) GetStorageOk() (*DataLakeStorage, bool)` + +GetStorageOk returns a tuple with the Storage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorage + +`func (o *DataLakeTenant) SetStorage(v DataLakeStorage)` + +SetStorage sets Storage field to given value. + +### HasStorage + +`func (o *DataLakeTenant) HasStorage() bool` + +HasStorage returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataLakeView.md b/docs/docs/DataLakeView.md new file mode 100644 index 00000000..c72ff47f --- /dev/null +++ b/docs/docs/DataLakeView.md @@ -0,0 +1,108 @@ +# DataLakeView + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection. | [optional] +**Pipeline** | Pointer to **string** | Aggregation pipeline stages to apply to the source collection. | [optional] +**Source** | Pointer to **string** | Human-readable label that identifies the source collection for the view. | [optional] + +## Methods + +### NewDataLakeView + +`func NewDataLakeView() *DataLakeView` + +NewDataLakeView instantiates a new DataLakeView object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataLakeViewWithDefaults + +`func NewDataLakeViewWithDefaults() *DataLakeView` + +NewDataLakeViewWithDefaults instantiates a new DataLakeView object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *DataLakeView) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataLakeView) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataLakeView) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataLakeView) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPipeline + +`func (o *DataLakeView) GetPipeline() string` + +GetPipeline returns the Pipeline field if non-nil, zero value otherwise. + +### GetPipelineOk + +`func (o *DataLakeView) GetPipelineOk() (*string, bool)` + +GetPipelineOk returns a tuple with the Pipeline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPipeline + +`func (o *DataLakeView) SetPipeline(v string)` + +SetPipeline sets Pipeline field to given value. + +### HasPipeline + +`func (o *DataLakeView) HasPipeline() bool` + +HasPipeline returns a boolean if a field has been set. + +### GetSource + +`func (o *DataLakeView) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *DataLakeView) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *DataLakeView) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *DataLakeView) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataMetricAlert.md b/docs/docs/DataMetricAlert.md new file mode 100644 index 00000000..bd32222f --- /dev/null +++ b/docs/docs/DataMetricAlert.md @@ -0,0 +1,489 @@ +# DataMetricAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**DataMetricValue**](DataMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventTypeViewAlertable**](HostMetricEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see <a href=\"https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types\" target=\"_blank\">Host Metrics</a>. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href=\"https://dochub.mongodb.org/core/alert-config-serverless-measurements\" target=\"_blank\">Serverless Measurements</a>. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewDataMetricAlert + +`func NewDataMetricAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName HostMetricEventTypeViewAlertable, id string, status string, updated time.Time, ) *DataMetricAlert` + +NewDataMetricAlert instantiates a new DataMetricAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataMetricAlertWithDefaults + +`func NewDataMetricAlertWithDefaults() *DataMetricAlert` + +NewDataMetricAlertWithDefaults instantiates a new DataMetricAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *DataMetricAlert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *DataMetricAlert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *DataMetricAlert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *DataMetricAlert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *DataMetricAlert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *DataMetricAlert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *DataMetricAlert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *DataMetricAlert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *DataMetricAlert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *DataMetricAlert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *DataMetricAlert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *DataMetricAlert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *DataMetricAlert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *DataMetricAlert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *DataMetricAlert) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *DataMetricAlert) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *DataMetricAlert) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *DataMetricAlert) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *DataMetricAlert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DataMetricAlert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DataMetricAlert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *DataMetricAlert) GetCurrentValue() DataMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *DataMetricAlert) GetCurrentValueOk() (*DataMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *DataMetricAlert) SetCurrentValue(v DataMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *DataMetricAlert) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *DataMetricAlert) GetEventTypeName() HostMetricEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *DataMetricAlert) GetEventTypeNameOk() (*HostMetricEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *DataMetricAlert) SetEventTypeName(v HostMetricEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *DataMetricAlert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DataMetricAlert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DataMetricAlert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *DataMetricAlert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *DataMetricAlert) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *DataMetricAlert) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *DataMetricAlert) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *DataMetricAlert) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetId + +`func (o *DataMetricAlert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DataMetricAlert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DataMetricAlert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *DataMetricAlert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *DataMetricAlert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *DataMetricAlert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *DataMetricAlert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *DataMetricAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DataMetricAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DataMetricAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DataMetricAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *DataMetricAlert) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *DataMetricAlert) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *DataMetricAlert) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *DataMetricAlert) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *DataMetricAlert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *DataMetricAlert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *DataMetricAlert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *DataMetricAlert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *DataMetricAlert) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *DataMetricAlert) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *DataMetricAlert) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *DataMetricAlert) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetResolved + +`func (o *DataMetricAlert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *DataMetricAlert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *DataMetricAlert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *DataMetricAlert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *DataMetricAlert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DataMetricAlert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DataMetricAlert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *DataMetricAlert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *DataMetricAlert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *DataMetricAlert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataMetricEvent.md b/docs/docs/DataMetricEvent.md new file mode 100644 index 00000000..6298b258 --- /dev/null +++ b/docs/docs/DataMetricEvent.md @@ -0,0 +1,483 @@ +# DataMetricEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**DataMetricValue**](DataMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventType**](HostMetricEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewDataMetricEvent + +`func NewDataMetricEvent(created time.Time, eventTypeName HostMetricEventType, id string, ) *DataMetricEvent` + +NewDataMetricEvent instantiates a new DataMetricEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataMetricEventWithDefaults + +`func NewDataMetricEventWithDefaults() *DataMetricEvent` + +NewDataMetricEventWithDefaults instantiates a new DataMetricEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *DataMetricEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *DataMetricEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *DataMetricEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *DataMetricEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *DataMetricEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DataMetricEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DataMetricEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *DataMetricEvent) GetCurrentValue() DataMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *DataMetricEvent) GetCurrentValueOk() (*DataMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *DataMetricEvent) SetCurrentValue(v DataMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *DataMetricEvent) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *DataMetricEvent) GetEventTypeName() HostMetricEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *DataMetricEvent) GetEventTypeNameOk() (*HostMetricEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *DataMetricEvent) SetEventTypeName(v HostMetricEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *DataMetricEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DataMetricEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DataMetricEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *DataMetricEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *DataMetricEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DataMetricEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DataMetricEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *DataMetricEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *DataMetricEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *DataMetricEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *DataMetricEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *DataMetricEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DataMetricEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DataMetricEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DataMetricEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *DataMetricEvent) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *DataMetricEvent) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *DataMetricEvent) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *DataMetricEvent) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *DataMetricEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *DataMetricEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *DataMetricEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *DataMetricEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPort + +`func (o *DataMetricEvent) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *DataMetricEvent) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *DataMetricEvent) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *DataMetricEvent) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *DataMetricEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *DataMetricEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *DataMetricEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *DataMetricEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *DataMetricEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *DataMetricEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *DataMetricEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *DataMetricEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *DataMetricEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *DataMetricEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *DataMetricEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *DataMetricEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *DataMetricEvent) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *DataMetricEvent) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *DataMetricEvent) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *DataMetricEvent) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *DataMetricEvent) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *DataMetricEvent) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *DataMetricEvent) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *DataMetricEvent) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetUserId + +`func (o *DataMetricEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *DataMetricEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *DataMetricEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *DataMetricEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *DataMetricEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *DataMetricEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *DataMetricEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *DataMetricEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataMetricThreshold.md b/docs/docs/DataMetricThreshold.md new file mode 100644 index 00000000..3083f157 --- /dev/null +++ b/docs/docs/DataMetricThreshold.md @@ -0,0 +1,160 @@ +# DataMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**DataMetricUnits**](DataMetricUnits.md) | | [optional] + +## Methods + +### NewDataMetricThreshold + +`func NewDataMetricThreshold() *DataMetricThreshold` + +NewDataMetricThreshold instantiates a new DataMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataMetricThresholdWithDefaults + +`func NewDataMetricThresholdWithDefaults() *DataMetricThreshold` + +NewDataMetricThresholdWithDefaults instantiates a new DataMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *DataMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *DataMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *DataMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *DataMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *DataMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *DataMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *DataMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *DataMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *DataMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *DataMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *DataMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *DataMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *DataMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *DataMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *DataMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *DataMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *DataMetricThreshold) GetUnits() DataMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *DataMetricThreshold) GetUnitsOk() (*DataMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *DataMetricThreshold) SetUnits(v DataMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *DataMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataMetricUnits.md b/docs/docs/DataMetricUnits.md new file mode 100644 index 00000000..4e1d404d --- /dev/null +++ b/docs/docs/DataMetricUnits.md @@ -0,0 +1,29 @@ +# DataMetricUnits + +## Enum + + +* `BITS` (value: `"BITS"`) + +* `KILOBITS` (value: `"KILOBITS"`) + +* `MEGABITS` (value: `"MEGABITS"`) + +* `GIGABITS` (value: `"GIGABITS"`) + +* `BYTES` (value: `"BYTES"`) + +* `KILOBYTES` (value: `"KILOBYTES"`) + +* `MEGABYTES` (value: `"MEGABYTES"`) + +* `GIGABYTES` (value: `"GIGABYTES"`) + +* `TERABYTES` (value: `"TERABYTES"`) + +* `PETABYTES` (value: `"PETABYTES"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataMetricValue.md b/docs/docs/DataMetricValue.md new file mode 100644 index 00000000..0872294f --- /dev/null +++ b/docs/docs/DataMetricValue.md @@ -0,0 +1,82 @@ +# DataMetricValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **float64** | Amount of the **metricName** recorded at the time of the event. This value triggered the alert. | [optional] [readonly] +**Units** | Pointer to [**DataMetricUnits**](DataMetricUnits.md) | | [optional] + +## Methods + +### NewDataMetricValue + +`func NewDataMetricValue() *DataMetricValue` + +NewDataMetricValue instantiates a new DataMetricValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataMetricValueWithDefaults + +`func NewDataMetricValueWithDefaults() *DataMetricValue` + +NewDataMetricValueWithDefaults instantiates a new DataMetricValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *DataMetricValue) GetNumber() float64` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *DataMetricValue) GetNumberOk() (*float64, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *DataMetricValue) SetNumber(v float64)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *DataMetricValue) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetUnits + +`func (o *DataMetricValue) GetUnits() DataMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *DataMetricValue) GetUnitsOk() (*DataMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *DataMetricValue) SetUnits(v DataMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *DataMetricValue) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DataProtectionSettings.md b/docs/docs/DataProtectionSettings.md new file mode 100644 index 00000000..e5fc362a --- /dev/null +++ b/docs/docs/DataProtectionSettings.md @@ -0,0 +1,316 @@ +# DataProtectionSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthorizedEmail** | Pointer to **string** | Email address of the user who authorized to updated the Backup Compliance Policy settings. | [optional] [readonly] +**CopyProtectionEnabled** | Pointer to **bool** | Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false. | [optional] [default to false] +**EncryptionAtRestEnabled** | Pointer to **bool** | Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false. | [optional] [default to false] +**OnDemandPolicyItem** | Pointer to [**PolicyItem**](PolicyItem.md) | | [optional] +**PitEnabled** | Pointer to **bool** | Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false. | [optional] [default to false] +**ProjectId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy. | [optional] +**RestoreWindowDays** | Pointer to **int** | Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy. | [optional] +**ScheduledPolicyItems** | Pointer to [**[]PolicyItem**](PolicyItem.md) | List that contains the specifications for one scheduled policy. | [optional] +**State** | Pointer to **string** | Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings. | [optional] [readonly] +**UpdatedDate** | Pointer to **time.Time** | ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings. | [optional] [readonly] +**UpdatedUser** | Pointer to **string** | Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings. | [optional] [readonly] + +## Methods + +### NewDataProtectionSettings + +`func NewDataProtectionSettings() *DataProtectionSettings` + +NewDataProtectionSettings instantiates a new DataProtectionSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataProtectionSettingsWithDefaults + +`func NewDataProtectionSettingsWithDefaults() *DataProtectionSettings` + +NewDataProtectionSettingsWithDefaults instantiates a new DataProtectionSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAuthorizedEmail + +`func (o *DataProtectionSettings) GetAuthorizedEmail() string` + +GetAuthorizedEmail returns the AuthorizedEmail field if non-nil, zero value otherwise. + +### GetAuthorizedEmailOk + +`func (o *DataProtectionSettings) GetAuthorizedEmailOk() (*string, bool)` + +GetAuthorizedEmailOk returns a tuple with the AuthorizedEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizedEmail + +`func (o *DataProtectionSettings) SetAuthorizedEmail(v string)` + +SetAuthorizedEmail sets AuthorizedEmail field to given value. + +### HasAuthorizedEmail + +`func (o *DataProtectionSettings) HasAuthorizedEmail() bool` + +HasAuthorizedEmail returns a boolean if a field has been set. + +### GetCopyProtectionEnabled + +`func (o *DataProtectionSettings) GetCopyProtectionEnabled() bool` + +GetCopyProtectionEnabled returns the CopyProtectionEnabled field if non-nil, zero value otherwise. + +### GetCopyProtectionEnabledOk + +`func (o *DataProtectionSettings) GetCopyProtectionEnabledOk() (*bool, bool)` + +GetCopyProtectionEnabledOk returns a tuple with the CopyProtectionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCopyProtectionEnabled + +`func (o *DataProtectionSettings) SetCopyProtectionEnabled(v bool)` + +SetCopyProtectionEnabled sets CopyProtectionEnabled field to given value. + +### HasCopyProtectionEnabled + +`func (o *DataProtectionSettings) HasCopyProtectionEnabled() bool` + +HasCopyProtectionEnabled returns a boolean if a field has been set. + +### GetEncryptionAtRestEnabled + +`func (o *DataProtectionSettings) GetEncryptionAtRestEnabled() bool` + +GetEncryptionAtRestEnabled returns the EncryptionAtRestEnabled field if non-nil, zero value otherwise. + +### GetEncryptionAtRestEnabledOk + +`func (o *DataProtectionSettings) GetEncryptionAtRestEnabledOk() (*bool, bool)` + +GetEncryptionAtRestEnabledOk returns a tuple with the EncryptionAtRestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionAtRestEnabled + +`func (o *DataProtectionSettings) SetEncryptionAtRestEnabled(v bool)` + +SetEncryptionAtRestEnabled sets EncryptionAtRestEnabled field to given value. + +### HasEncryptionAtRestEnabled + +`func (o *DataProtectionSettings) HasEncryptionAtRestEnabled() bool` + +HasEncryptionAtRestEnabled returns a boolean if a field has been set. + +### GetOnDemandPolicyItem + +`func (o *DataProtectionSettings) GetOnDemandPolicyItem() PolicyItem` + +GetOnDemandPolicyItem returns the OnDemandPolicyItem field if non-nil, zero value otherwise. + +### GetOnDemandPolicyItemOk + +`func (o *DataProtectionSettings) GetOnDemandPolicyItemOk() (*PolicyItem, bool)` + +GetOnDemandPolicyItemOk returns a tuple with the OnDemandPolicyItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnDemandPolicyItem + +`func (o *DataProtectionSettings) SetOnDemandPolicyItem(v PolicyItem)` + +SetOnDemandPolicyItem sets OnDemandPolicyItem field to given value. + +### HasOnDemandPolicyItem + +`func (o *DataProtectionSettings) HasOnDemandPolicyItem() bool` + +HasOnDemandPolicyItem returns a boolean if a field has been set. + +### GetPitEnabled + +`func (o *DataProtectionSettings) GetPitEnabled() bool` + +GetPitEnabled returns the PitEnabled field if non-nil, zero value otherwise. + +### GetPitEnabledOk + +`func (o *DataProtectionSettings) GetPitEnabledOk() (*bool, bool)` + +GetPitEnabledOk returns a tuple with the PitEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPitEnabled + +`func (o *DataProtectionSettings) SetPitEnabled(v bool)` + +SetPitEnabled sets PitEnabled field to given value. + +### HasPitEnabled + +`func (o *DataProtectionSettings) HasPitEnabled() bool` + +HasPitEnabled returns a boolean if a field has been set. + +### GetProjectId + +`func (o *DataProtectionSettings) GetProjectId() string` + +GetProjectId returns the ProjectId field if non-nil, zero value otherwise. + +### GetProjectIdOk + +`func (o *DataProtectionSettings) GetProjectIdOk() (*string, bool)` + +GetProjectIdOk returns a tuple with the ProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProjectId + +`func (o *DataProtectionSettings) SetProjectId(v string)` + +SetProjectId sets ProjectId field to given value. + +### HasProjectId + +`func (o *DataProtectionSettings) HasProjectId() bool` + +HasProjectId returns a boolean if a field has been set. + +### GetRestoreWindowDays + +`func (o *DataProtectionSettings) GetRestoreWindowDays() int` + +GetRestoreWindowDays returns the RestoreWindowDays field if non-nil, zero value otherwise. + +### GetRestoreWindowDaysOk + +`func (o *DataProtectionSettings) GetRestoreWindowDaysOk() (*int, bool)` + +GetRestoreWindowDaysOk returns a tuple with the RestoreWindowDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestoreWindowDays + +`func (o *DataProtectionSettings) SetRestoreWindowDays(v int)` + +SetRestoreWindowDays sets RestoreWindowDays field to given value. + +### HasRestoreWindowDays + +`func (o *DataProtectionSettings) HasRestoreWindowDays() bool` + +HasRestoreWindowDays returns a boolean if a field has been set. + +### GetScheduledPolicyItems + +`func (o *DataProtectionSettings) GetScheduledPolicyItems() []PolicyItem` + +GetScheduledPolicyItems returns the ScheduledPolicyItems field if non-nil, zero value otherwise. + +### GetScheduledPolicyItemsOk + +`func (o *DataProtectionSettings) GetScheduledPolicyItemsOk() (*[]PolicyItem, bool)` + +GetScheduledPolicyItemsOk returns a tuple with the ScheduledPolicyItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduledPolicyItems + +`func (o *DataProtectionSettings) SetScheduledPolicyItems(v []PolicyItem)` + +SetScheduledPolicyItems sets ScheduledPolicyItems field to given value. + +### HasScheduledPolicyItems + +`func (o *DataProtectionSettings) HasScheduledPolicyItems() bool` + +HasScheduledPolicyItems returns a boolean if a field has been set. + +### GetState + +`func (o *DataProtectionSettings) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *DataProtectionSettings) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *DataProtectionSettings) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *DataProtectionSettings) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetUpdatedDate + +`func (o *DataProtectionSettings) GetUpdatedDate() time.Time` + +GetUpdatedDate returns the UpdatedDate field if non-nil, zero value otherwise. + +### GetUpdatedDateOk + +`func (o *DataProtectionSettings) GetUpdatedDateOk() (*time.Time, bool)` + +GetUpdatedDateOk returns a tuple with the UpdatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedDate + +`func (o *DataProtectionSettings) SetUpdatedDate(v time.Time)` + +SetUpdatedDate sets UpdatedDate field to given value. + +### HasUpdatedDate + +`func (o *DataProtectionSettings) HasUpdatedDate() bool` + +HasUpdatedDate returns a boolean if a field has been set. + +### GetUpdatedUser + +`func (o *DataProtectionSettings) GetUpdatedUser() string` + +GetUpdatedUser returns the UpdatedUser field if non-nil, zero value otherwise. + +### GetUpdatedUserOk + +`func (o *DataProtectionSettings) GetUpdatedUserOk() (*string, bool)` + +GetUpdatedUserOk returns a tuple with the UpdatedUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedUser + +`func (o *DataProtectionSettings) SetUpdatedUser(v string)` + +SetUpdatedUser sets UpdatedUser field to given value. + +### HasUpdatedUser + +`func (o *DataProtectionSettings) HasUpdatedUser() bool` + +HasUpdatedUser returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Database.md b/docs/docs/Database.md new file mode 100644 index 00000000..eaa77c2e --- /dev/null +++ b/docs/docs/Database.md @@ -0,0 +1,82 @@ +# Database + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DatabaseName** | Pointer to **string** | Human-readable label that identifies the database that the specified MongoDB process serves. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewDatabase + +`func NewDatabase() *Database` + +NewDatabase instantiates a new Database object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDatabaseWithDefaults + +`func NewDatabaseWithDefaults() *Database` + +NewDatabaseWithDefaults instantiates a new Database object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDatabaseName + +`func (o *Database) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *Database) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *Database) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + +### HasDatabaseName + +`func (o *Database) HasDatabaseName() bool` + +HasDatabaseName returns a boolean if a field has been set. + +### GetLinks + +`func (o *Database) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Database) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Database) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Database) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DatabaseUser.md b/docs/docs/DatabaseUser.md new file mode 100644 index 00000000..b051f3b1 --- /dev/null +++ b/docs/docs/DatabaseUser.md @@ -0,0 +1,327 @@ +# DatabaseUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsIAMType** | Pointer to **string** | Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role. | [optional] [default to "NONE"] +**DatabaseName** | **string** | Database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. | [default to "admin"] +**DeleteAfterDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request. | [optional] +**GroupId** | **string** | Unique 24-hexadecimal digit string that identifies the project. | +**Labels** | Pointer to [**[]NDSLabel**](NDSLabel.md) | List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console. | [optional] +**LdapAuthType** | Pointer to **string** | Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host. | [optional] [default to "NONE"] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Password** | Pointer to **string** | Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response. | [optional] +**Roles** | Pointer to [**[]Role**](Role.md) | List that provides the pairings of one role with one applicable database. | [optional] +**Scopes** | Pointer to [**[]UserScope**](UserScope.md) | List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project. | [optional] +**Username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | | +**X509Type** | Pointer to **string** | X.509 method that MongoDB Cloud uses to authenticate the database user. - For application-managed X.509, specify `MANAGED`. - For self-managed X.509, specify `CUSTOMER`. Users created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database. | [optional] [default to "NONE"] + +## Methods + +### NewDatabaseUser + +`func NewDatabaseUser(databaseName string, groupId string, username string, ) *DatabaseUser` + +NewDatabaseUser instantiates a new DatabaseUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDatabaseUserWithDefaults + +`func NewDatabaseUserWithDefaults() *DatabaseUser` + +NewDatabaseUserWithDefaults instantiates a new DatabaseUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAwsIAMType + +`func (o *DatabaseUser) GetAwsIAMType() string` + +GetAwsIAMType returns the AwsIAMType field if non-nil, zero value otherwise. + +### GetAwsIAMTypeOk + +`func (o *DatabaseUser) GetAwsIAMTypeOk() (*string, bool)` + +GetAwsIAMTypeOk returns a tuple with the AwsIAMType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsIAMType + +`func (o *DatabaseUser) SetAwsIAMType(v string)` + +SetAwsIAMType sets AwsIAMType field to given value. + +### HasAwsIAMType + +`func (o *DatabaseUser) HasAwsIAMType() bool` + +HasAwsIAMType returns a boolean if a field has been set. + +### GetDatabaseName + +`func (o *DatabaseUser) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *DatabaseUser) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *DatabaseUser) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + + +### GetDeleteAfterDate + +`func (o *DatabaseUser) GetDeleteAfterDate() time.Time` + +GetDeleteAfterDate returns the DeleteAfterDate field if non-nil, zero value otherwise. + +### GetDeleteAfterDateOk + +`func (o *DatabaseUser) GetDeleteAfterDateOk() (*time.Time, bool)` + +GetDeleteAfterDateOk returns a tuple with the DeleteAfterDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteAfterDate + +`func (o *DatabaseUser) SetDeleteAfterDate(v time.Time)` + +SetDeleteAfterDate sets DeleteAfterDate field to given value. + +### HasDeleteAfterDate + +`func (o *DatabaseUser) HasDeleteAfterDate() bool` + +HasDeleteAfterDate returns a boolean if a field has been set. + +### GetGroupId + +`func (o *DatabaseUser) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DatabaseUser) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DatabaseUser) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + + +### GetLabels + +`func (o *DatabaseUser) GetLabels() []NDSLabel` + +GetLabels returns the Labels field if non-nil, zero value otherwise. + +### GetLabelsOk + +`func (o *DatabaseUser) GetLabelsOk() (*[]NDSLabel, bool)` + +GetLabelsOk returns a tuple with the Labels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabels + +`func (o *DatabaseUser) SetLabels(v []NDSLabel)` + +SetLabels sets Labels field to given value. + +### HasLabels + +`func (o *DatabaseUser) HasLabels() bool` + +HasLabels returns a boolean if a field has been set. + +### GetLdapAuthType + +`func (o *DatabaseUser) GetLdapAuthType() string` + +GetLdapAuthType returns the LdapAuthType field if non-nil, zero value otherwise. + +### GetLdapAuthTypeOk + +`func (o *DatabaseUser) GetLdapAuthTypeOk() (*string, bool)` + +GetLdapAuthTypeOk returns a tuple with the LdapAuthType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLdapAuthType + +`func (o *DatabaseUser) SetLdapAuthType(v string)` + +SetLdapAuthType sets LdapAuthType field to given value. + +### HasLdapAuthType + +`func (o *DatabaseUser) HasLdapAuthType() bool` + +HasLdapAuthType returns a boolean if a field has been set. + +### GetLinks + +`func (o *DatabaseUser) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DatabaseUser) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DatabaseUser) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DatabaseUser) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetPassword + +`func (o *DatabaseUser) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *DatabaseUser) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *DatabaseUser) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *DatabaseUser) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetRoles + +`func (o *DatabaseUser) GetRoles() []Role` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *DatabaseUser) GetRolesOk() (*[]Role, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *DatabaseUser) SetRoles(v []Role)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *DatabaseUser) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetScopes + +`func (o *DatabaseUser) GetScopes() []UserScope` + +GetScopes returns the Scopes field if non-nil, zero value otherwise. + +### GetScopesOk + +`func (o *DatabaseUser) GetScopesOk() (*[]UserScope, bool)` + +GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopes + +`func (o *DatabaseUser) SetScopes(v []UserScope)` + +SetScopes sets Scopes field to given value. + +### HasScopes + +`func (o *DatabaseUser) HasScopes() bool` + +HasScopes returns a boolean if a field has been set. + +### GetUsername + +`func (o *DatabaseUser) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *DatabaseUser) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *DatabaseUser) SetUsername(v string)` + +SetUsername sets Username field to given value. + + +### GetX509Type + +`func (o *DatabaseUser) GetX509Type() string` + +GetX509Type returns the X509Type field if non-nil, zero value otherwise. + +### GetX509TypeOk + +`func (o *DatabaseUser) GetX509TypeOk() (*string, bool)` + +GetX509TypeOk returns a tuple with the X509Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetX509Type + +`func (o *DatabaseUser) SetX509Type(v string)` + +SetX509Type sets X509Type field to given value. + +### HasX509Type + +`func (o *DatabaseUser) HasX509Type() bool` + +HasX509Type returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DatabaseUsersApi.md b/docs/docs/DatabaseUsersApi.md new file mode 100644 index 00000000..1f89e411 --- /dev/null +++ b/docs/docs/DatabaseUsersApi.md @@ -0,0 +1,409 @@ +# \DatabaseUsersApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateDatabaseUser**](DatabaseUsersApi.md#CreateDatabaseUser) | **Post** /api/atlas/v2/groups/{groupId}/databaseUsers | Create One Database User in One Project +[**DeleteDatabaseUser**](DatabaseUsersApi.md#DeleteDatabaseUser) | **Delete** /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username} | Remove One Database User from One Project +[**GetDatabaseUser**](DatabaseUsersApi.md#GetDatabaseUser) | **Get** /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username} | Return One Database User from One Project +[**ListDatabaseUsers**](DatabaseUsersApi.md#ListDatabaseUsers) | **Get** /api/atlas/v2/groups/{groupId}/databaseUsers | Return All Database Users from One Project +[**UpdateDatabaseUser**](DatabaseUsersApi.md#UpdateDatabaseUser) | **Patch** /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username} | Update One Database User in One Project + + + +## CreateDatabaseUser + +> DatabaseUser CreateDatabaseUser(ctx, groupId).DatabaseUser(databaseUser).Execute() + +Create One Database User in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + databaseUser := *openapiclient.NewDatabaseUser("DatabaseName_example", "32b6e34b3d91647abb20e7b8", "Username_example") // DatabaseUser | + + resp, r, err := sdk.DatabaseUsersApi.CreateDatabaseUser(context.Background(), groupId).DatabaseUser(databaseUser).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DatabaseUsersApi.CreateDatabaseUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateDatabaseUser`: DatabaseUser + fmt.Fprintf(os.Stdout, "Response from `DatabaseUsersApi.CreateDatabaseUser`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDatabaseUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **databaseUser** | [**DatabaseUser**](DatabaseUser.md) | Creates one database user in the specified project. | + +### Return type + +[**DatabaseUser**](DatabaseUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteDatabaseUser + +> DeleteDatabaseUser(ctx, groupId, databaseName, username).Execute() + +Remove One Database User from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + databaseName := "databaseName_example" // string | + username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM" // string | + + r, err := sdk.DatabaseUsersApi.DeleteDatabaseUser(context.Background(), groupId, databaseName, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DatabaseUsersApi.DeleteDatabaseUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**databaseName** | **string** | Human-readable label that identifies the database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`. | +**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDatabaseUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetDatabaseUser + +> DatabaseUser GetDatabaseUser(ctx, groupId, databaseName, username).Execute() + +Return One Database User from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + databaseName := "databaseName_example" // string | + username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM" // string | + + resp, r, err := sdk.DatabaseUsersApi.GetDatabaseUser(context.Background(), groupId, databaseName, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DatabaseUsersApi.GetDatabaseUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetDatabaseUser`: DatabaseUser + fmt.Fprintf(os.Stdout, "Response from `DatabaseUsersApi.GetDatabaseUser`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**databaseName** | **string** | Human-readable label that identifies the database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`. | +**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDatabaseUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**DatabaseUser**](DatabaseUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListDatabaseUsers + +> PaginatedApiAtlasDatabaseUser ListDatabaseUsers(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Database Users from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.DatabaseUsersApi.ListDatabaseUsers(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DatabaseUsersApi.ListDatabaseUsers``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListDatabaseUsers`: PaginatedApiAtlasDatabaseUser + fmt.Fprintf(os.Stdout, "Response from `DatabaseUsersApi.ListDatabaseUsers`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDatabaseUsersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiAtlasDatabaseUser**](PaginatedApiAtlasDatabaseUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateDatabaseUser + +> DatabaseUser UpdateDatabaseUser(ctx, groupId, databaseName, username).DatabaseUser(databaseUser).Execute() + +Update One Database User in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + databaseName := "databaseName_example" // string | + username := "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM" // string | + databaseUser := *openapiclient.NewDatabaseUser("DatabaseName_example", "32b6e34b3d91647abb20e7b8", "Username_example") // DatabaseUser | + + resp, r, err := sdk.DatabaseUsersApi.UpdateDatabaseUser(context.Background(), groupId, databaseName, username).DatabaseUser(databaseUser).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DatabaseUsersApi.UpdateDatabaseUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateDatabaseUser`: DatabaseUser + fmt.Fprintf(os.Stdout, "Response from `DatabaseUsersApi.UpdateDatabaseUser`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**databaseName** | **string** | Human-readable label that identifies the database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be `$external`. If the user authenticates with SCRAM-SHA, this value should be `admin`. | +**username** | **string** | Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication: | Authentication Method | Parameter Needed | Parameter Value | username Format | |---|---|---|---| | AWS IAM | awsType | ROLE | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | AWS IAM | awsType | USER | <abbr title=\"Amazon Resource Name\">ARN</abbr> | | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name | | SCRAM-SHA | awsType, x509Type, ldapAuthType | NONE | Alphanumeric string | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateDatabaseUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **databaseUser** | [**DatabaseUser**](DatabaseUser.md) | Updates one database user that belongs to the specified project. | + +### Return type + +[**DatabaseUser**](DatabaseUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/Datadog.md b/docs/docs/Datadog.md new file mode 100644 index 00000000..a326fa28 --- /dev/null +++ b/docs/docs/Datadog.md @@ -0,0 +1,103 @@ +# Datadog + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | **string** | Key that allows MongoDB Cloud to access your Datadog account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | +**Region** | Pointer to **string** | Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. To learn more about Datadog's regions, see <a href=\"https://docs.datadoghq.com/getting_started/site/\" target=\"_blank\" rel=\"noopener noreferrer\">Datadog Sites</a>. | [optional] +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] + +## Methods + +### NewDatadog + +`func NewDatadog(apiKey string, ) *Datadog` + +NewDatadog instantiates a new Datadog object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDatadogWithDefaults + +`func NewDatadogWithDefaults() *Datadog` + +NewDatadogWithDefaults instantiates a new Datadog object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKey + +`func (o *Datadog) GetApiKey() string` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *Datadog) GetApiKeyOk() (*string, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *Datadog) SetApiKey(v string)` + +SetApiKey sets ApiKey field to given value. + + +### GetRegion + +`func (o *Datadog) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *Datadog) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *Datadog) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *Datadog) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetType + +`func (o *Datadog) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Datadog) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Datadog) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Datadog) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DatadogNotification.md b/docs/docs/DatadogNotification.md new file mode 100644 index 00000000..ab8a6dc7 --- /dev/null +++ b/docs/docs/DatadogNotification.md @@ -0,0 +1,155 @@ +# DatadogNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DatadogApiKey** | Pointer to **string** | Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**DatadogRegion** | Pointer to **string** | Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. To learn more about Datadog's regions, see <a href=\"https://docs.datadoghq.com/getting_started/site/\" target=\"_blank\" rel=\"noopener noreferrer\">Datadog Sites</a>. | [optional] [default to "US"] +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewDatadogNotification + +`func NewDatadogNotification(typeName string, ) *DatadogNotification` + +NewDatadogNotification instantiates a new DatadogNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDatadogNotificationWithDefaults + +`func NewDatadogNotificationWithDefaults() *DatadogNotification` + +NewDatadogNotificationWithDefaults instantiates a new DatadogNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDatadogApiKey + +`func (o *DatadogNotification) GetDatadogApiKey() string` + +GetDatadogApiKey returns the DatadogApiKey field if non-nil, zero value otherwise. + +### GetDatadogApiKeyOk + +`func (o *DatadogNotification) GetDatadogApiKeyOk() (*string, bool)` + +GetDatadogApiKeyOk returns a tuple with the DatadogApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatadogApiKey + +`func (o *DatadogNotification) SetDatadogApiKey(v string)` + +SetDatadogApiKey sets DatadogApiKey field to given value. + +### HasDatadogApiKey + +`func (o *DatadogNotification) HasDatadogApiKey() bool` + +HasDatadogApiKey returns a boolean if a field has been set. + +### GetDatadogRegion + +`func (o *DatadogNotification) GetDatadogRegion() string` + +GetDatadogRegion returns the DatadogRegion field if non-nil, zero value otherwise. + +### GetDatadogRegionOk + +`func (o *DatadogNotification) GetDatadogRegionOk() (*string, bool)` + +GetDatadogRegionOk returns a tuple with the DatadogRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatadogRegion + +`func (o *DatadogNotification) SetDatadogRegion(v string)` + +SetDatadogRegion sets DatadogRegion field to given value. + +### HasDatadogRegion + +`func (o *DatadogNotification) HasDatadogRegion() bool` + +HasDatadogRegion returns a boolean if a field has been set. + +### GetDelayMin + +`func (o *DatadogNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *DatadogNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *DatadogNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *DatadogNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *DatadogNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *DatadogNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *DatadogNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *DatadogNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *DatadogNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *DatadogNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *DatadogNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DateCriteria.md b/docs/docs/DateCriteria.md new file mode 100644 index 00000000..a06d6084 --- /dev/null +++ b/docs/docs/DateCriteria.md @@ -0,0 +1,134 @@ +# DateCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DateField** | Pointer to **string** | Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`. | [optional] +**DateFormat** | Pointer to **string** | Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**. You must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**. | [optional] [default to "ISODATE"] +**ExpireAfterDays** | Pointer to **int** | Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**. | [optional] +**Type** | Pointer to **string** | Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query. **DATE** selects documents to archive based on a date. **CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`. | [optional] + +## Methods + +### NewDateCriteria + +`func NewDateCriteria() *DateCriteria` + +NewDateCriteria instantiates a new DateCriteria object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDateCriteriaWithDefaults + +`func NewDateCriteriaWithDefaults() *DateCriteria` + +NewDateCriteriaWithDefaults instantiates a new DateCriteria object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDateField + +`func (o *DateCriteria) GetDateField() string` + +GetDateField returns the DateField field if non-nil, zero value otherwise. + +### GetDateFieldOk + +`func (o *DateCriteria) GetDateFieldOk() (*string, bool)` + +GetDateFieldOk returns a tuple with the DateField field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateField + +`func (o *DateCriteria) SetDateField(v string)` + +SetDateField sets DateField field to given value. + +### HasDateField + +`func (o *DateCriteria) HasDateField() bool` + +HasDateField returns a boolean if a field has been set. + +### GetDateFormat + +`func (o *DateCriteria) GetDateFormat() string` + +GetDateFormat returns the DateFormat field if non-nil, zero value otherwise. + +### GetDateFormatOk + +`func (o *DateCriteria) GetDateFormatOk() (*string, bool)` + +GetDateFormatOk returns a tuple with the DateFormat field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateFormat + +`func (o *DateCriteria) SetDateFormat(v string)` + +SetDateFormat sets DateFormat field to given value. + +### HasDateFormat + +`func (o *DateCriteria) HasDateFormat() bool` + +HasDateFormat returns a boolean if a field has been set. + +### GetExpireAfterDays + +`func (o *DateCriteria) GetExpireAfterDays() int` + +GetExpireAfterDays returns the ExpireAfterDays field if non-nil, zero value otherwise. + +### GetExpireAfterDaysOk + +`func (o *DateCriteria) GetExpireAfterDaysOk() (*int, bool)` + +GetExpireAfterDaysOk returns a tuple with the ExpireAfterDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpireAfterDays + +`func (o *DateCriteria) SetExpireAfterDays(v int)` + +SetExpireAfterDays sets ExpireAfterDays field to given value. + +### HasExpireAfterDays + +`func (o *DateCriteria) HasExpireAfterDays() bool` + +HasExpireAfterDays returns a boolean if a field has been set. + +### GetType + +`func (o *DateCriteria) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DateCriteria) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DateCriteria) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DateCriteria) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DedicatedHardwareSpec.md b/docs/docs/DedicatedHardwareSpec.md new file mode 100644 index 00000000..c91bdeed --- /dev/null +++ b/docs/docs/DedicatedHardwareSpec.md @@ -0,0 +1,134 @@ +# DedicatedHardwareSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NodeCount** | Pointer to **int** | Number of nodes of the given type for MongoDB Cloud to deploy to the region. | [optional] +**DiskIOPS** | Pointer to **int** | Target throughput desired for storage attached to your AWS-provisioned cluster. Change this parameter only if you: - set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"AWS\"`. - set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M30\"` or greater not including `Mxx_NVME` tiers. The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. This parameter defaults to the cluster tier's standard IOPS value. Changing this value impacts cluster cost. MongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets. - Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1. - Instance sizes greater than `M40` have a ratio of 120:1. | [optional] +**EbsVolumeType** | Pointer to **string** | Type of storage you want to attach to your AWS-provisioned cluster. - `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. - `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. | [optional] [default to "STANDARD"] +**InstanceSize** | Pointer to **string** | Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. | [optional] + +## Methods + +### NewDedicatedHardwareSpec + +`func NewDedicatedHardwareSpec() *DedicatedHardwareSpec` + +NewDedicatedHardwareSpec instantiates a new DedicatedHardwareSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDedicatedHardwareSpecWithDefaults + +`func NewDedicatedHardwareSpecWithDefaults() *DedicatedHardwareSpec` + +NewDedicatedHardwareSpecWithDefaults instantiates a new DedicatedHardwareSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNodeCount + +`func (o *DedicatedHardwareSpec) GetNodeCount() int` + +GetNodeCount returns the NodeCount field if non-nil, zero value otherwise. + +### GetNodeCountOk + +`func (o *DedicatedHardwareSpec) GetNodeCountOk() (*int, bool)` + +GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNodeCount + +`func (o *DedicatedHardwareSpec) SetNodeCount(v int)` + +SetNodeCount sets NodeCount field to given value. + +### HasNodeCount + +`func (o *DedicatedHardwareSpec) HasNodeCount() bool` + +HasNodeCount returns a boolean if a field has been set. + +### GetDiskIOPS + +`func (o *DedicatedHardwareSpec) GetDiskIOPS() int` + +GetDiskIOPS returns the DiskIOPS field if non-nil, zero value otherwise. + +### GetDiskIOPSOk + +`func (o *DedicatedHardwareSpec) GetDiskIOPSOk() (*int, bool)` + +GetDiskIOPSOk returns a tuple with the DiskIOPS field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskIOPS + +`func (o *DedicatedHardwareSpec) SetDiskIOPS(v int)` + +SetDiskIOPS sets DiskIOPS field to given value. + +### HasDiskIOPS + +`func (o *DedicatedHardwareSpec) HasDiskIOPS() bool` + +HasDiskIOPS returns a boolean if a field has been set. + +### GetEbsVolumeType + +`func (o *DedicatedHardwareSpec) GetEbsVolumeType() string` + +GetEbsVolumeType returns the EbsVolumeType field if non-nil, zero value otherwise. + +### GetEbsVolumeTypeOk + +`func (o *DedicatedHardwareSpec) GetEbsVolumeTypeOk() (*string, bool)` + +GetEbsVolumeTypeOk returns a tuple with the EbsVolumeType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEbsVolumeType + +`func (o *DedicatedHardwareSpec) SetEbsVolumeType(v string)` + +SetEbsVolumeType sets EbsVolumeType field to given value. + +### HasEbsVolumeType + +`func (o *DedicatedHardwareSpec) HasEbsVolumeType() bool` + +HasEbsVolumeType returns a boolean if a field has been set. + +### GetInstanceSize + +`func (o *DedicatedHardwareSpec) GetInstanceSize() string` + +GetInstanceSize returns the InstanceSize field if non-nil, zero value otherwise. + +### GetInstanceSizeOk + +`func (o *DedicatedHardwareSpec) GetInstanceSizeOk() (*string, bool)` + +GetInstanceSizeOk returns a tuple with the InstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSize + +`func (o *DedicatedHardwareSpec) SetInstanceSize(v string)` + +SetInstanceSize sets InstanceSize field to given value. + +### HasInstanceSize + +`func (o *DedicatedHardwareSpec) HasInstanceSize() bool` + +HasInstanceSize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DefaultAlertConfigViewForNdsGroup.md b/docs/docs/DefaultAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..249abced --- /dev/null +++ b/docs/docs/DefaultAlertConfigViewForNdsGroup.md @@ -0,0 +1,259 @@ +# DefaultAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | **string** | Incident that triggered this alert. | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewDefaultAlertConfigViewForNdsGroup + +`func NewDefaultAlertConfigViewForNdsGroup(eventTypeName string, ) *DefaultAlertConfigViewForNdsGroup` + +NewDefaultAlertConfigViewForNdsGroup instantiates a new DefaultAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDefaultAlertConfigViewForNdsGroupWithDefaults + +`func NewDefaultAlertConfigViewForNdsGroupWithDefaults() *DefaultAlertConfigViewForNdsGroup` + +NewDefaultAlertConfigViewForNdsGroupWithDefaults instantiates a new DefaultAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *DefaultAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DefaultAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *DefaultAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *DefaultAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *DefaultAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *DefaultAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *DefaultAlertConfigViewForNdsGroup) GetEventTypeName() string` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*string, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *DefaultAlertConfigViewForNdsGroup) SetEventTypeName(v string)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *DefaultAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DefaultAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *DefaultAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *DefaultAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DefaultAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DefaultAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *DefaultAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DefaultAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DefaultAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *DefaultAlertConfigViewForNdsGroup) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *DefaultAlertConfigViewForNdsGroup) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *DefaultAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *DefaultAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *DefaultAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *DefaultAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *DefaultAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *DefaultAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *DefaultAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *DefaultAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DefaultAlertViewForNdsGroup.md b/docs/docs/DefaultAlertViewForNdsGroup.md new file mode 100644 index 00000000..ba68b855 --- /dev/null +++ b/docs/docs/DefaultAlertViewForNdsGroup.md @@ -0,0 +1,359 @@ +# DefaultAlertViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | **string** | Incident that triggered this alert. | [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewDefaultAlertViewForNdsGroup + +`func NewDefaultAlertViewForNdsGroup(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName string, id string, status string, updated time.Time, ) *DefaultAlertViewForNdsGroup` + +NewDefaultAlertViewForNdsGroup instantiates a new DefaultAlertViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDefaultAlertViewForNdsGroupWithDefaults + +`func NewDefaultAlertViewForNdsGroupWithDefaults() *DefaultAlertViewForNdsGroup` + +NewDefaultAlertViewForNdsGroupWithDefaults instantiates a new DefaultAlertViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *DefaultAlertViewForNdsGroup) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *DefaultAlertViewForNdsGroup) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *DefaultAlertViewForNdsGroup) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *DefaultAlertViewForNdsGroup) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *DefaultAlertViewForNdsGroup) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *DefaultAlertViewForNdsGroup) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *DefaultAlertViewForNdsGroup) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *DefaultAlertViewForNdsGroup) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *DefaultAlertViewForNdsGroup) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *DefaultAlertViewForNdsGroup) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *DefaultAlertViewForNdsGroup) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *DefaultAlertViewForNdsGroup) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *DefaultAlertViewForNdsGroup) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *DefaultAlertViewForNdsGroup) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetCreated + +`func (o *DefaultAlertViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DefaultAlertViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DefaultAlertViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *DefaultAlertViewForNdsGroup) GetEventTypeName() string` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *DefaultAlertViewForNdsGroup) GetEventTypeNameOk() (*string, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *DefaultAlertViewForNdsGroup) SetEventTypeName(v string)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *DefaultAlertViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DefaultAlertViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DefaultAlertViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *DefaultAlertViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *DefaultAlertViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DefaultAlertViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DefaultAlertViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *DefaultAlertViewForNdsGroup) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *DefaultAlertViewForNdsGroup) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *DefaultAlertViewForNdsGroup) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *DefaultAlertViewForNdsGroup) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *DefaultAlertViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DefaultAlertViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DefaultAlertViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DefaultAlertViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *DefaultAlertViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *DefaultAlertViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *DefaultAlertViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *DefaultAlertViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetResolved + +`func (o *DefaultAlertViewForNdsGroup) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *DefaultAlertViewForNdsGroup) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *DefaultAlertViewForNdsGroup) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *DefaultAlertViewForNdsGroup) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *DefaultAlertViewForNdsGroup) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DefaultAlertViewForNdsGroup) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DefaultAlertViewForNdsGroup) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *DefaultAlertViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *DefaultAlertViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *DefaultAlertViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DefaultEventViewForNdsGroup.md b/docs/docs/DefaultEventViewForNdsGroup.md new file mode 100644 index 00000000..6706ecd2 --- /dev/null +++ b/docs/docs/DefaultEventViewForNdsGroup.md @@ -0,0 +1,353 @@ +# DefaultEventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | **string** | Unique identifier of event type. | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewDefaultEventViewForNdsGroup + +`func NewDefaultEventViewForNdsGroup(created time.Time, eventTypeName string, id string, ) *DefaultEventViewForNdsGroup` + +NewDefaultEventViewForNdsGroup instantiates a new DefaultEventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDefaultEventViewForNdsGroupWithDefaults + +`func NewDefaultEventViewForNdsGroupWithDefaults() *DefaultEventViewForNdsGroup` + +NewDefaultEventViewForNdsGroupWithDefaults instantiates a new DefaultEventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *DefaultEventViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *DefaultEventViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *DefaultEventViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *DefaultEventViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *DefaultEventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DefaultEventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DefaultEventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *DefaultEventViewForNdsGroup) GetEventTypeName() string` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *DefaultEventViewForNdsGroup) GetEventTypeNameOk() (*string, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *DefaultEventViewForNdsGroup) SetEventTypeName(v string)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *DefaultEventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DefaultEventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DefaultEventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *DefaultEventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *DefaultEventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DefaultEventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DefaultEventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *DefaultEventViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *DefaultEventViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *DefaultEventViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *DefaultEventViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *DefaultEventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DefaultEventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DefaultEventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DefaultEventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *DefaultEventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *DefaultEventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *DefaultEventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *DefaultEventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *DefaultEventViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *DefaultEventViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *DefaultEventViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *DefaultEventViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *DefaultEventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *DefaultEventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *DefaultEventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *DefaultEventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *DefaultEventViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *DefaultEventViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *DefaultEventViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *DefaultEventViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *DefaultEventViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *DefaultEventViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *DefaultEventViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *DefaultEventViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *DefaultEventViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *DefaultEventViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *DefaultEventViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *DefaultEventViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DefaultEventViewForOrg.md b/docs/docs/DefaultEventViewForOrg.md new file mode 100644 index 00000000..b4ddd8d6 --- /dev/null +++ b/docs/docs/DefaultEventViewForOrg.md @@ -0,0 +1,353 @@ +# DefaultEventViewForOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | **string** | Unique identifier of event type. | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewDefaultEventViewForOrg + +`func NewDefaultEventViewForOrg(created time.Time, eventTypeName string, id string, ) *DefaultEventViewForOrg` + +NewDefaultEventViewForOrg instantiates a new DefaultEventViewForOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDefaultEventViewForOrgWithDefaults + +`func NewDefaultEventViewForOrgWithDefaults() *DefaultEventViewForOrg` + +NewDefaultEventViewForOrgWithDefaults instantiates a new DefaultEventViewForOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *DefaultEventViewForOrg) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *DefaultEventViewForOrg) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *DefaultEventViewForOrg) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *DefaultEventViewForOrg) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *DefaultEventViewForOrg) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DefaultEventViewForOrg) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DefaultEventViewForOrg) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *DefaultEventViewForOrg) GetEventTypeName() string` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *DefaultEventViewForOrg) GetEventTypeNameOk() (*string, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *DefaultEventViewForOrg) SetEventTypeName(v string)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *DefaultEventViewForOrg) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *DefaultEventViewForOrg) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *DefaultEventViewForOrg) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *DefaultEventViewForOrg) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *DefaultEventViewForOrg) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DefaultEventViewForOrg) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DefaultEventViewForOrg) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *DefaultEventViewForOrg) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *DefaultEventViewForOrg) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *DefaultEventViewForOrg) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *DefaultEventViewForOrg) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *DefaultEventViewForOrg) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DefaultEventViewForOrg) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DefaultEventViewForOrg) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DefaultEventViewForOrg) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *DefaultEventViewForOrg) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *DefaultEventViewForOrg) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *DefaultEventViewForOrg) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *DefaultEventViewForOrg) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *DefaultEventViewForOrg) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *DefaultEventViewForOrg) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *DefaultEventViewForOrg) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *DefaultEventViewForOrg) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *DefaultEventViewForOrg) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *DefaultEventViewForOrg) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *DefaultEventViewForOrg) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *DefaultEventViewForOrg) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *DefaultEventViewForOrg) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *DefaultEventViewForOrg) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *DefaultEventViewForOrg) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *DefaultEventViewForOrg) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *DefaultEventViewForOrg) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *DefaultEventViewForOrg) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *DefaultEventViewForOrg) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *DefaultEventViewForOrg) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *DefaultEventViewForOrg) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *DefaultEventViewForOrg) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *DefaultEventViewForOrg) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *DefaultEventViewForOrg) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DefaultLimit.md b/docs/docs/DefaultLimit.md new file mode 100644 index 00000000..c71604e4 --- /dev/null +++ b/docs/docs/DefaultLimit.md @@ -0,0 +1,150 @@ +# DefaultLimit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CurrentUsage** | Pointer to **int64** | Amount that indicates the current usage of the limit. | [optional] [readonly] +**DefaultLimit** | Pointer to **int64** | Default value of the limit. | [optional] [readonly] +**MaximumLimit** | Pointer to **int64** | Maximum value of the limit. | [optional] [readonly] +**Name** | **string** | Human-readable label that identifies the user-managed limit to modify. | [readonly] +**Value** | **int64** | Amount to set the limit to. | + +## Methods + +### NewDefaultLimit + +`func NewDefaultLimit(name string, value int64, ) *DefaultLimit` + +NewDefaultLimit instantiates a new DefaultLimit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDefaultLimitWithDefaults + +`func NewDefaultLimitWithDefaults() *DefaultLimit` + +NewDefaultLimitWithDefaults instantiates a new DefaultLimit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCurrentUsage + +`func (o *DefaultLimit) GetCurrentUsage() int64` + +GetCurrentUsage returns the CurrentUsage field if non-nil, zero value otherwise. + +### GetCurrentUsageOk + +`func (o *DefaultLimit) GetCurrentUsageOk() (*int64, bool)` + +GetCurrentUsageOk returns a tuple with the CurrentUsage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentUsage + +`func (o *DefaultLimit) SetCurrentUsage(v int64)` + +SetCurrentUsage sets CurrentUsage field to given value. + +### HasCurrentUsage + +`func (o *DefaultLimit) HasCurrentUsage() bool` + +HasCurrentUsage returns a boolean if a field has been set. + +### GetDefaultLimit + +`func (o *DefaultLimit) GetDefaultLimit() int64` + +GetDefaultLimit returns the DefaultLimit field if non-nil, zero value otherwise. + +### GetDefaultLimitOk + +`func (o *DefaultLimit) GetDefaultLimitOk() (*int64, bool)` + +GetDefaultLimitOk returns a tuple with the DefaultLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultLimit + +`func (o *DefaultLimit) SetDefaultLimit(v int64)` + +SetDefaultLimit sets DefaultLimit field to given value. + +### HasDefaultLimit + +`func (o *DefaultLimit) HasDefaultLimit() bool` + +HasDefaultLimit returns a boolean if a field has been set. + +### GetMaximumLimit + +`func (o *DefaultLimit) GetMaximumLimit() int64` + +GetMaximumLimit returns the MaximumLimit field if non-nil, zero value otherwise. + +### GetMaximumLimitOk + +`func (o *DefaultLimit) GetMaximumLimitOk() (*int64, bool)` + +GetMaximumLimitOk returns a tuple with the MaximumLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaximumLimit + +`func (o *DefaultLimit) SetMaximumLimit(v int64)` + +SetMaximumLimit sets MaximumLimit field to given value. + +### HasMaximumLimit + +`func (o *DefaultLimit) HasMaximumLimit() bool` + +HasMaximumLimit returns a boolean if a field has been set. + +### GetName + +`func (o *DefaultLimit) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DefaultLimit) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DefaultLimit) SetName(v string)` + +SetName sets Name field to given value. + + +### GetValue + +`func (o *DefaultLimit) GetValue() int64` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DefaultLimit) GetValueOk() (*int64, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DefaultLimit) SetValue(v int64)` + +SetValue sets Value field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DefaultSchedule.md b/docs/docs/DefaultSchedule.md new file mode 100644 index 00000000..1c8da599 --- /dev/null +++ b/docs/docs/DefaultSchedule.md @@ -0,0 +1,51 @@ +# DefaultSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | | + +## Methods + +### NewDefaultSchedule + +`func NewDefaultSchedule(type_ string, ) *DefaultSchedule` + +NewDefaultSchedule instantiates a new DefaultSchedule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDefaultScheduleWithDefaults + +`func NewDefaultScheduleWithDefaults() *DefaultSchedule` + +NewDefaultScheduleWithDefaults instantiates a new DefaultSchedule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *DefaultSchedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DefaultSchedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DefaultSchedule) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DeleteCopiedBackups.md b/docs/docs/DeleteCopiedBackups.md new file mode 100644 index 00000000..1ec2431d --- /dev/null +++ b/docs/docs/DeleteCopiedBackups.md @@ -0,0 +1,108 @@ +# DeleteCopiedBackups + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProvider** | Pointer to **string** | Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete. | [optional] +**RegionName** | Pointer to **string** | Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link. | [optional] +**ReplicationSpecId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster). | [optional] + +## Methods + +### NewDeleteCopiedBackups + +`func NewDeleteCopiedBackups() *DeleteCopiedBackups` + +NewDeleteCopiedBackups instantiates a new DeleteCopiedBackups object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeleteCopiedBackupsWithDefaults + +`func NewDeleteCopiedBackupsWithDefaults() *DeleteCopiedBackups` + +NewDeleteCopiedBackupsWithDefaults instantiates a new DeleteCopiedBackups object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProvider + +`func (o *DeleteCopiedBackups) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *DeleteCopiedBackups) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *DeleteCopiedBackups) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + +### HasCloudProvider + +`func (o *DeleteCopiedBackups) HasCloudProvider() bool` + +HasCloudProvider returns a boolean if a field has been set. + +### GetRegionName + +`func (o *DeleteCopiedBackups) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *DeleteCopiedBackups) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *DeleteCopiedBackups) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *DeleteCopiedBackups) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetReplicationSpecId + +`func (o *DeleteCopiedBackups) GetReplicationSpecId() string` + +GetReplicationSpecId returns the ReplicationSpecId field if non-nil, zero value otherwise. + +### GetReplicationSpecIdOk + +`func (o *DeleteCopiedBackups) GetReplicationSpecIdOk() (*string, bool)` + +GetReplicationSpecIdOk returns a tuple with the ReplicationSpecId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicationSpecId + +`func (o *DeleteCopiedBackups) SetReplicationSpecId(v string)` + +SetReplicationSpecId sets ReplicationSpecId field to given value. + +### HasReplicationSpecId + +`func (o *DeleteCopiedBackups) HasReplicationSpecId() bool` + +HasReplicationSpecId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Destination.md b/docs/docs/Destination.md new file mode 100644 index 00000000..6fb96c42 --- /dev/null +++ b/docs/docs/Destination.md @@ -0,0 +1,119 @@ +# Destination + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | **string** | Label that identifies the destination cluster. | +**GroupId** | **string** | Unique 24-hexadecimal digit string that identifies the destination project. | +**HostnameSchemaType** | **string** | The network type to use between the migration host and the target cluster. | [default to "PUBLIC"] +**PrivateLinkId** | Pointer to **string** | Represents the endpoint to use when the host schema type is `PRIVATE_LINK`. | [optional] + +## Methods + +### NewDestination + +`func NewDestination(clusterName string, groupId string, hostnameSchemaType string, ) *Destination` + +NewDestination instantiates a new Destination object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDestinationWithDefaults + +`func NewDestinationWithDefaults() *Destination` + +NewDestinationWithDefaults instantiates a new Destination object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *Destination) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *Destination) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *Destination) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + + +### GetGroupId + +`func (o *Destination) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *Destination) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *Destination) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + + +### GetHostnameSchemaType + +`func (o *Destination) GetHostnameSchemaType() string` + +GetHostnameSchemaType returns the HostnameSchemaType field if non-nil, zero value otherwise. + +### GetHostnameSchemaTypeOk + +`func (o *Destination) GetHostnameSchemaTypeOk() (*string, bool)` + +GetHostnameSchemaTypeOk returns a tuple with the HostnameSchemaType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameSchemaType + +`func (o *Destination) SetHostnameSchemaType(v string)` + +SetHostnameSchemaType sets HostnameSchemaType field to given value. + + +### GetPrivateLinkId + +`func (o *Destination) GetPrivateLinkId() string` + +GetPrivateLinkId returns the PrivateLinkId field if non-nil, zero value otherwise. + +### GetPrivateLinkIdOk + +`func (o *Destination) GetPrivateLinkIdOk() (*string, bool)` + +GetPrivateLinkIdOk returns a tuple with the PrivateLinkId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateLinkId + +`func (o *Destination) SetPrivateLinkId(v string)` + +SetPrivateLinkId sets PrivateLinkId field to given value. + +### HasPrivateLinkId + +`func (o *Destination) HasPrivateLinkId() bool` + +HasPrivateLinkId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupBaseRestoreMember.md b/docs/docs/DiskBackupBaseRestoreMember.md new file mode 100644 index 00000000..cddc1bd5 --- /dev/null +++ b/docs/docs/DiskBackupBaseRestoreMember.md @@ -0,0 +1,56 @@ +# DiskBackupBaseRestoreMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReplicaSetName** | Pointer to **string** | Human-readable label that identifies the replica set on the sharded cluster. | [optional] [readonly] + +## Methods + +### NewDiskBackupBaseRestoreMember + +`func NewDiskBackupBaseRestoreMember() *DiskBackupBaseRestoreMember` + +NewDiskBackupBaseRestoreMember instantiates a new DiskBackupBaseRestoreMember object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupBaseRestoreMemberWithDefaults + +`func NewDiskBackupBaseRestoreMemberWithDefaults() *DiskBackupBaseRestoreMember` + +NewDiskBackupBaseRestoreMemberWithDefaults instantiates a new DiskBackupBaseRestoreMember object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetReplicaSetName + +`func (o *DiskBackupBaseRestoreMember) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *DiskBackupBaseRestoreMember) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *DiskBackupBaseRestoreMember) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *DiskBackupBaseRestoreMember) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupCopySetting.md b/docs/docs/DiskBackupCopySetting.md new file mode 100644 index 00000000..ce53bb23 --- /dev/null +++ b/docs/docs/DiskBackupCopySetting.md @@ -0,0 +1,160 @@ +# DiskBackupCopySetting + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProvider** | Pointer to **string** | Human-readable label that identifies the cloud provider that stores the snapshot copy. | [optional] +**Frequencies** | Pointer to **[]string** | List that describes which types of snapshots to copy. | [optional] +**RegionName** | Pointer to **string** | Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link. | [optional] +**ReplicationSpecId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster). | [optional] +**ShouldCopyOplogs** | Pointer to **bool** | Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores. | [optional] + +## Methods + +### NewDiskBackupCopySetting + +`func NewDiskBackupCopySetting() *DiskBackupCopySetting` + +NewDiskBackupCopySetting instantiates a new DiskBackupCopySetting object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupCopySettingWithDefaults + +`func NewDiskBackupCopySettingWithDefaults() *DiskBackupCopySetting` + +NewDiskBackupCopySettingWithDefaults instantiates a new DiskBackupCopySetting object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProvider + +`func (o *DiskBackupCopySetting) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *DiskBackupCopySetting) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *DiskBackupCopySetting) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + +### HasCloudProvider + +`func (o *DiskBackupCopySetting) HasCloudProvider() bool` + +HasCloudProvider returns a boolean if a field has been set. + +### GetFrequencies + +`func (o *DiskBackupCopySetting) GetFrequencies() []string` + +GetFrequencies returns the Frequencies field if non-nil, zero value otherwise. + +### GetFrequenciesOk + +`func (o *DiskBackupCopySetting) GetFrequenciesOk() (*[]string, bool)` + +GetFrequenciesOk returns a tuple with the Frequencies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencies + +`func (o *DiskBackupCopySetting) SetFrequencies(v []string)` + +SetFrequencies sets Frequencies field to given value. + +### HasFrequencies + +`func (o *DiskBackupCopySetting) HasFrequencies() bool` + +HasFrequencies returns a boolean if a field has been set. + +### GetRegionName + +`func (o *DiskBackupCopySetting) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *DiskBackupCopySetting) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *DiskBackupCopySetting) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *DiskBackupCopySetting) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetReplicationSpecId + +`func (o *DiskBackupCopySetting) GetReplicationSpecId() string` + +GetReplicationSpecId returns the ReplicationSpecId field if non-nil, zero value otherwise. + +### GetReplicationSpecIdOk + +`func (o *DiskBackupCopySetting) GetReplicationSpecIdOk() (*string, bool)` + +GetReplicationSpecIdOk returns a tuple with the ReplicationSpecId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicationSpecId + +`func (o *DiskBackupCopySetting) SetReplicationSpecId(v string)` + +SetReplicationSpecId sets ReplicationSpecId field to given value. + +### HasReplicationSpecId + +`func (o *DiskBackupCopySetting) HasReplicationSpecId() bool` + +HasReplicationSpecId returns a boolean if a field has been set. + +### GetShouldCopyOplogs + +`func (o *DiskBackupCopySetting) GetShouldCopyOplogs() bool` + +GetShouldCopyOplogs returns the ShouldCopyOplogs field if non-nil, zero value otherwise. + +### GetShouldCopyOplogsOk + +`func (o *DiskBackupCopySetting) GetShouldCopyOplogsOk() (*bool, bool)` + +GetShouldCopyOplogsOk returns a tuple with the ShouldCopyOplogs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShouldCopyOplogs + +`func (o *DiskBackupCopySetting) SetShouldCopyOplogs(v bool)` + +SetShouldCopyOplogs sets ShouldCopyOplogs field to given value. + +### HasShouldCopyOplogs + +`func (o *DiskBackupCopySetting) HasShouldCopyOplogs() bool` + +HasShouldCopyOplogs returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupExportJob.md b/docs/docs/DiskBackupExportJob.md new file mode 100644 index 00000000..69e0d2ce --- /dev/null +++ b/docs/docs/DiskBackupExportJob.md @@ -0,0 +1,337 @@ +# DiskBackupExportJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Components** | Pointer to [**[]DiskBackupBaseRestoreMember**](DiskBackupBaseRestoreMember.md) | Information on the export job for each replica set in the sharded cluster. | [optional] [readonly] +**CreatedAt** | Pointer to **time.Time** | Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**CustomData** | Pointer to [**[]Label**](Label.md) | Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. | [optional] +**DeliveryUrl** | Pointer to **[]string** | One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`. | [optional] [readonly] +**ExportBucketId** | **string** | Unique 24-hexadecimal character string that identifies the AWS bucket to which MongoDB Cloud exports the Cloud Backup snapshot. | [readonly] +**ExportStatus** | Pointer to [**ExportStatus**](ExportStatus.md) | | [optional] +**FinishedAt** | Pointer to **time.Time** | Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the restore job. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Prefix** | Pointer to **string** | Full path on the cloud provider bucket to the folder where the snapshot is exported. | [optional] [readonly] +**SnapshotId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the snapshot. | [optional] +**State** | Pointer to **string** | State of the export job. | [optional] [readonly] + +## Methods + +### NewDiskBackupExportJob + +`func NewDiskBackupExportJob(exportBucketId string, ) *DiskBackupExportJob` + +NewDiskBackupExportJob instantiates a new DiskBackupExportJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupExportJobWithDefaults + +`func NewDiskBackupExportJobWithDefaults() *DiskBackupExportJob` + +NewDiskBackupExportJobWithDefaults instantiates a new DiskBackupExportJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetComponents + +`func (o *DiskBackupExportJob) GetComponents() []DiskBackupBaseRestoreMember` + +GetComponents returns the Components field if non-nil, zero value otherwise. + +### GetComponentsOk + +`func (o *DiskBackupExportJob) GetComponentsOk() (*[]DiskBackupBaseRestoreMember, bool)` + +GetComponentsOk returns a tuple with the Components field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComponents + +`func (o *DiskBackupExportJob) SetComponents(v []DiskBackupBaseRestoreMember)` + +SetComponents sets Components field to given value. + +### HasComponents + +`func (o *DiskBackupExportJob) HasComponents() bool` + +HasComponents returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *DiskBackupExportJob) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *DiskBackupExportJob) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *DiskBackupExportJob) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *DiskBackupExportJob) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetCustomData + +`func (o *DiskBackupExportJob) GetCustomData() []Label` + +GetCustomData returns the CustomData field if non-nil, zero value otherwise. + +### GetCustomDataOk + +`func (o *DiskBackupExportJob) GetCustomDataOk() (*[]Label, bool)` + +GetCustomDataOk returns a tuple with the CustomData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomData + +`func (o *DiskBackupExportJob) SetCustomData(v []Label)` + +SetCustomData sets CustomData field to given value. + +### HasCustomData + +`func (o *DiskBackupExportJob) HasCustomData() bool` + +HasCustomData returns a boolean if a field has been set. + +### GetDeliveryUrl + +`func (o *DiskBackupExportJob) GetDeliveryUrl() []string` + +GetDeliveryUrl returns the DeliveryUrl field if non-nil, zero value otherwise. + +### GetDeliveryUrlOk + +`func (o *DiskBackupExportJob) GetDeliveryUrlOk() (*[]string, bool)` + +GetDeliveryUrlOk returns a tuple with the DeliveryUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryUrl + +`func (o *DiskBackupExportJob) SetDeliveryUrl(v []string)` + +SetDeliveryUrl sets DeliveryUrl field to given value. + +### HasDeliveryUrl + +`func (o *DiskBackupExportJob) HasDeliveryUrl() bool` + +HasDeliveryUrl returns a boolean if a field has been set. + +### GetExportBucketId + +`func (o *DiskBackupExportJob) GetExportBucketId() string` + +GetExportBucketId returns the ExportBucketId field if non-nil, zero value otherwise. + +### GetExportBucketIdOk + +`func (o *DiskBackupExportJob) GetExportBucketIdOk() (*string, bool)` + +GetExportBucketIdOk returns a tuple with the ExportBucketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportBucketId + +`func (o *DiskBackupExportJob) SetExportBucketId(v string)` + +SetExportBucketId sets ExportBucketId field to given value. + + +### GetExportStatus + +`func (o *DiskBackupExportJob) GetExportStatus() ExportStatus` + +GetExportStatus returns the ExportStatus field if non-nil, zero value otherwise. + +### GetExportStatusOk + +`func (o *DiskBackupExportJob) GetExportStatusOk() (*ExportStatus, bool)` + +GetExportStatusOk returns a tuple with the ExportStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportStatus + +`func (o *DiskBackupExportJob) SetExportStatus(v ExportStatus)` + +SetExportStatus sets ExportStatus field to given value. + +### HasExportStatus + +`func (o *DiskBackupExportJob) HasExportStatus() bool` + +HasExportStatus returns a boolean if a field has been set. + +### GetFinishedAt + +`func (o *DiskBackupExportJob) GetFinishedAt() time.Time` + +GetFinishedAt returns the FinishedAt field if non-nil, zero value otherwise. + +### GetFinishedAtOk + +`func (o *DiskBackupExportJob) GetFinishedAtOk() (*time.Time, bool)` + +GetFinishedAtOk returns a tuple with the FinishedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinishedAt + +`func (o *DiskBackupExportJob) SetFinishedAt(v time.Time)` + +SetFinishedAt sets FinishedAt field to given value. + +### HasFinishedAt + +`func (o *DiskBackupExportJob) HasFinishedAt() bool` + +HasFinishedAt returns a boolean if a field has been set. + +### GetId + +`func (o *DiskBackupExportJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DiskBackupExportJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DiskBackupExportJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DiskBackupExportJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupExportJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupExportJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupExportJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupExportJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetPrefix + +`func (o *DiskBackupExportJob) GetPrefix() string` + +GetPrefix returns the Prefix field if non-nil, zero value otherwise. + +### GetPrefixOk + +`func (o *DiskBackupExportJob) GetPrefixOk() (*string, bool)` + +GetPrefixOk returns a tuple with the Prefix field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrefix + +`func (o *DiskBackupExportJob) SetPrefix(v string)` + +SetPrefix sets Prefix field to given value. + +### HasPrefix + +`func (o *DiskBackupExportJob) HasPrefix() bool` + +HasPrefix returns a boolean if a field has been set. + +### GetSnapshotId + +`func (o *DiskBackupExportJob) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *DiskBackupExportJob) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *DiskBackupExportJob) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + +### HasSnapshotId + +`func (o *DiskBackupExportJob) HasSnapshotId() bool` + +HasSnapshotId returns a boolean if a field has been set. + +### GetState + +`func (o *DiskBackupExportJob) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *DiskBackupExportJob) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *DiskBackupExportJob) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *DiskBackupExportJob) HasState() bool` + +HasState returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupExportJobRequest.md b/docs/docs/DiskBackupExportJobRequest.md new file mode 100644 index 00000000..0a9fede5 --- /dev/null +++ b/docs/docs/DiskBackupExportJobRequest.md @@ -0,0 +1,124 @@ +# DiskBackupExportJobRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomData** | Pointer to [**[]Label**](Label.md) | Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. | [optional] +**ExportBucketId** | **string** | Unique 24-hexadecimal character string that identifies the AWS bucket to which MongoDB Cloud exports the Cloud Backup snapshot. | +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**SnapshotId** | **string** | Unique 24-hexadecimal character string that identifies the Cloud Backup snasphot to export. | + +## Methods + +### NewDiskBackupExportJobRequest + +`func NewDiskBackupExportJobRequest(exportBucketId string, snapshotId string, ) *DiskBackupExportJobRequest` + +NewDiskBackupExportJobRequest instantiates a new DiskBackupExportJobRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupExportJobRequestWithDefaults + +`func NewDiskBackupExportJobRequestWithDefaults() *DiskBackupExportJobRequest` + +NewDiskBackupExportJobRequestWithDefaults instantiates a new DiskBackupExportJobRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCustomData + +`func (o *DiskBackupExportJobRequest) GetCustomData() []Label` + +GetCustomData returns the CustomData field if non-nil, zero value otherwise. + +### GetCustomDataOk + +`func (o *DiskBackupExportJobRequest) GetCustomDataOk() (*[]Label, bool)` + +GetCustomDataOk returns a tuple with the CustomData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomData + +`func (o *DiskBackupExportJobRequest) SetCustomData(v []Label)` + +SetCustomData sets CustomData field to given value. + +### HasCustomData + +`func (o *DiskBackupExportJobRequest) HasCustomData() bool` + +HasCustomData returns a boolean if a field has been set. + +### GetExportBucketId + +`func (o *DiskBackupExportJobRequest) GetExportBucketId() string` + +GetExportBucketId returns the ExportBucketId field if non-nil, zero value otherwise. + +### GetExportBucketIdOk + +`func (o *DiskBackupExportJobRequest) GetExportBucketIdOk() (*string, bool)` + +GetExportBucketIdOk returns a tuple with the ExportBucketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportBucketId + +`func (o *DiskBackupExportJobRequest) SetExportBucketId(v string)` + +SetExportBucketId sets ExportBucketId field to given value. + + +### GetLinks + +`func (o *DiskBackupExportJobRequest) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupExportJobRequest) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupExportJobRequest) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupExportJobRequest) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetSnapshotId + +`func (o *DiskBackupExportJobRequest) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *DiskBackupExportJobRequest) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *DiskBackupExportJobRequest) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupOnDemandSnapshotRequest.md b/docs/docs/DiskBackupOnDemandSnapshotRequest.md new file mode 100644 index 00000000..88c63c07 --- /dev/null +++ b/docs/docs/DiskBackupOnDemandSnapshotRequest.md @@ -0,0 +1,108 @@ +# DiskBackupOnDemandSnapshotRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**RetentionInDays** | Pointer to **int** | Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**. | [optional] + +## Methods + +### NewDiskBackupOnDemandSnapshotRequest + +`func NewDiskBackupOnDemandSnapshotRequest() *DiskBackupOnDemandSnapshotRequest` + +NewDiskBackupOnDemandSnapshotRequest instantiates a new DiskBackupOnDemandSnapshotRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupOnDemandSnapshotRequestWithDefaults + +`func NewDiskBackupOnDemandSnapshotRequestWithDefaults() *DiskBackupOnDemandSnapshotRequest` + +NewDiskBackupOnDemandSnapshotRequestWithDefaults instantiates a new DiskBackupOnDemandSnapshotRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDescription + +`func (o *DiskBackupOnDemandSnapshotRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DiskBackupOnDemandSnapshotRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DiskBackupOnDemandSnapshotRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DiskBackupOnDemandSnapshotRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupOnDemandSnapshotRequest) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupOnDemandSnapshotRequest) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupOnDemandSnapshotRequest) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupOnDemandSnapshotRequest) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetRetentionInDays + +`func (o *DiskBackupOnDemandSnapshotRequest) GetRetentionInDays() int` + +GetRetentionInDays returns the RetentionInDays field if non-nil, zero value otherwise. + +### GetRetentionInDaysOk + +`func (o *DiskBackupOnDemandSnapshotRequest) GetRetentionInDaysOk() (*int, bool)` + +GetRetentionInDaysOk returns a tuple with the RetentionInDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetentionInDays + +`func (o *DiskBackupOnDemandSnapshotRequest) SetRetentionInDays(v int)` + +SetRetentionInDays sets RetentionInDays field to given value. + +### HasRetentionInDays + +`func (o *DiskBackupOnDemandSnapshotRequest) HasRetentionInDays() bool` + +HasRetentionInDays returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupReplicaSet.md b/docs/docs/DiskBackupReplicaSet.md new file mode 100644 index 00000000..2a02a7c2 --- /dev/null +++ b/docs/docs/DiskBackupReplicaSet.md @@ -0,0 +1,446 @@ +# DiskBackupReplicaSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProvider** | Pointer to **string** | Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`. | [optional] [readonly] +**CopyRegions** | Pointer to **[]string** | List that identifies the regions to which MongoDB Cloud copies the snapshot. | [optional] [readonly] +**CreatedAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Description** | Pointer to **string** | Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FrequencyType** | Pointer to **string** | Human-readable label that identifies how often this snapshot triggers. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the snapshot. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MasterKeyUUID** | Pointer to **string** | Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`. | [optional] [readonly] +**MongodVersion** | Pointer to **string** | Version of the MongoDB host that this snapshot backs up. | [optional] [readonly] +**PolicyItems** | Pointer to **[]string** | List that contains unique identifiers for the policy items. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`. | [optional] [readonly] +**SnapshotType** | Pointer to **string** | Human-readable label that identifies when this snapshot triggers. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable label that indicates the stage of the backup process for this snapshot. | [optional] [readonly] +**StorageSizeBytes** | Pointer to **int64** | Number of bytes taken to store the backup snapshot. | [optional] [readonly] +**Type** | Pointer to **string** | Human-readable label that categorizes the cluster as a replica set or sharded cluster. | [optional] [readonly] + +## Methods + +### NewDiskBackupReplicaSet + +`func NewDiskBackupReplicaSet() *DiskBackupReplicaSet` + +NewDiskBackupReplicaSet instantiates a new DiskBackupReplicaSet object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupReplicaSetWithDefaults + +`func NewDiskBackupReplicaSetWithDefaults() *DiskBackupReplicaSet` + +NewDiskBackupReplicaSetWithDefaults instantiates a new DiskBackupReplicaSet object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProvider + +`func (o *DiskBackupReplicaSet) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *DiskBackupReplicaSet) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *DiskBackupReplicaSet) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + +### HasCloudProvider + +`func (o *DiskBackupReplicaSet) HasCloudProvider() bool` + +HasCloudProvider returns a boolean if a field has been set. + +### GetCopyRegions + +`func (o *DiskBackupReplicaSet) GetCopyRegions() []string` + +GetCopyRegions returns the CopyRegions field if non-nil, zero value otherwise. + +### GetCopyRegionsOk + +`func (o *DiskBackupReplicaSet) GetCopyRegionsOk() (*[]string, bool)` + +GetCopyRegionsOk returns a tuple with the CopyRegions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCopyRegions + +`func (o *DiskBackupReplicaSet) SetCopyRegions(v []string)` + +SetCopyRegions sets CopyRegions field to given value. + +### HasCopyRegions + +`func (o *DiskBackupReplicaSet) HasCopyRegions() bool` + +HasCopyRegions returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *DiskBackupReplicaSet) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *DiskBackupReplicaSet) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *DiskBackupReplicaSet) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *DiskBackupReplicaSet) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetDescription + +`func (o *DiskBackupReplicaSet) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DiskBackupReplicaSet) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DiskBackupReplicaSet) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DiskBackupReplicaSet) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *DiskBackupReplicaSet) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *DiskBackupReplicaSet) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *DiskBackupReplicaSet) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *DiskBackupReplicaSet) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetFrequencyType + +`func (o *DiskBackupReplicaSet) GetFrequencyType() string` + +GetFrequencyType returns the FrequencyType field if non-nil, zero value otherwise. + +### GetFrequencyTypeOk + +`func (o *DiskBackupReplicaSet) GetFrequencyTypeOk() (*string, bool)` + +GetFrequencyTypeOk returns a tuple with the FrequencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencyType + +`func (o *DiskBackupReplicaSet) SetFrequencyType(v string)` + +SetFrequencyType sets FrequencyType field to given value. + +### HasFrequencyType + +`func (o *DiskBackupReplicaSet) HasFrequencyType() bool` + +HasFrequencyType returns a boolean if a field has been set. + +### GetId + +`func (o *DiskBackupReplicaSet) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DiskBackupReplicaSet) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DiskBackupReplicaSet) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DiskBackupReplicaSet) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupReplicaSet) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupReplicaSet) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupReplicaSet) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupReplicaSet) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMasterKeyUUID + +`func (o *DiskBackupReplicaSet) GetMasterKeyUUID() string` + +GetMasterKeyUUID returns the MasterKeyUUID field if non-nil, zero value otherwise. + +### GetMasterKeyUUIDOk + +`func (o *DiskBackupReplicaSet) GetMasterKeyUUIDOk() (*string, bool)` + +GetMasterKeyUUIDOk returns a tuple with the MasterKeyUUID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMasterKeyUUID + +`func (o *DiskBackupReplicaSet) SetMasterKeyUUID(v string)` + +SetMasterKeyUUID sets MasterKeyUUID field to given value. + +### HasMasterKeyUUID + +`func (o *DiskBackupReplicaSet) HasMasterKeyUUID() bool` + +HasMasterKeyUUID returns a boolean if a field has been set. + +### GetMongodVersion + +`func (o *DiskBackupReplicaSet) GetMongodVersion() string` + +GetMongodVersion returns the MongodVersion field if non-nil, zero value otherwise. + +### GetMongodVersionOk + +`func (o *DiskBackupReplicaSet) GetMongodVersionOk() (*string, bool)` + +GetMongodVersionOk returns a tuple with the MongodVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongodVersion + +`func (o *DiskBackupReplicaSet) SetMongodVersion(v string)` + +SetMongodVersion sets MongodVersion field to given value. + +### HasMongodVersion + +`func (o *DiskBackupReplicaSet) HasMongodVersion() bool` + +HasMongodVersion returns a boolean if a field has been set. + +### GetPolicyItems + +`func (o *DiskBackupReplicaSet) GetPolicyItems() []string` + +GetPolicyItems returns the PolicyItems field if non-nil, zero value otherwise. + +### GetPolicyItemsOk + +`func (o *DiskBackupReplicaSet) GetPolicyItemsOk() (*[]string, bool)` + +GetPolicyItemsOk returns a tuple with the PolicyItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyItems + +`func (o *DiskBackupReplicaSet) SetPolicyItems(v []string)` + +SetPolicyItems sets PolicyItems field to given value. + +### HasPolicyItems + +`func (o *DiskBackupReplicaSet) HasPolicyItems() bool` + +HasPolicyItems returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *DiskBackupReplicaSet) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *DiskBackupReplicaSet) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *DiskBackupReplicaSet) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *DiskBackupReplicaSet) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetSnapshotType + +`func (o *DiskBackupReplicaSet) GetSnapshotType() string` + +GetSnapshotType returns the SnapshotType field if non-nil, zero value otherwise. + +### GetSnapshotTypeOk + +`func (o *DiskBackupReplicaSet) GetSnapshotTypeOk() (*string, bool)` + +GetSnapshotTypeOk returns a tuple with the SnapshotType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotType + +`func (o *DiskBackupReplicaSet) SetSnapshotType(v string)` + +SetSnapshotType sets SnapshotType field to given value. + +### HasSnapshotType + +`func (o *DiskBackupReplicaSet) HasSnapshotType() bool` + +HasSnapshotType returns a boolean if a field has been set. + +### GetStatus + +`func (o *DiskBackupReplicaSet) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DiskBackupReplicaSet) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DiskBackupReplicaSet) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *DiskBackupReplicaSet) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStorageSizeBytes + +`func (o *DiskBackupReplicaSet) GetStorageSizeBytes() int64` + +GetStorageSizeBytes returns the StorageSizeBytes field if non-nil, zero value otherwise. + +### GetStorageSizeBytesOk + +`func (o *DiskBackupReplicaSet) GetStorageSizeBytesOk() (*int64, bool)` + +GetStorageSizeBytesOk returns a tuple with the StorageSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageSizeBytes + +`func (o *DiskBackupReplicaSet) SetStorageSizeBytes(v int64)` + +SetStorageSizeBytes sets StorageSizeBytes field to given value. + +### HasStorageSizeBytes + +`func (o *DiskBackupReplicaSet) HasStorageSizeBytes() bool` + +HasStorageSizeBytes returns a boolean if a field has been set. + +### GetType + +`func (o *DiskBackupReplicaSet) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DiskBackupReplicaSet) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DiskBackupReplicaSet) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DiskBackupReplicaSet) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupRestoreJob.md b/docs/docs/DiskBackupRestoreJob.md new file mode 100644 index 00000000..7234e33e --- /dev/null +++ b/docs/docs/DiskBackupRestoreJob.md @@ -0,0 +1,483 @@ +# DiskBackupRestoreJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Cancelled** | Pointer to **bool** | Flag that indicates whether someone canceled this restore job. | [optional] [readonly] +**Components** | Pointer to [**[]DiskBackupBaseRestoreMember**](DiskBackupBaseRestoreMember.md) | Information on the restore job for each replica set in the sharded cluster. | [optional] [readonly] +**DeliveryType** | **string** | Human-readable label that categorizes the restore job to create. | +**DeliveryUrl** | Pointer to **[]string** | One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`. | [optional] [readonly] +**DesiredTimestamp** | Pointer to [**BSONTimestamp**](BSONTimestamp.md) | | [optional] +**Expired** | Pointer to **bool** | Flag that indicates whether the restore job expired. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Failed** | Pointer to **bool** | Flag that indicates whether the restore job failed. | [optional] [readonly] +**FinishedAt** | Pointer to **time.Time** | Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the restore job. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OplogInc** | Pointer to **int** | Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`. | [optional] +**OplogTs** | Pointer to **int** | Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`. | [optional] +**PointInTimeUTCSeconds** | Pointer to **int** | Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`. | [optional] +**SnapshotId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the snapshot. | [optional] +**TargetClusterName** | **string** | Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. | +**TargetGroupId** | **string** | Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. | +**Timestamp** | Pointer to **time.Time** | Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewDiskBackupRestoreJob + +`func NewDiskBackupRestoreJob(deliveryType string, targetClusterName string, targetGroupId string, ) *DiskBackupRestoreJob` + +NewDiskBackupRestoreJob instantiates a new DiskBackupRestoreJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupRestoreJobWithDefaults + +`func NewDiskBackupRestoreJobWithDefaults() *DiskBackupRestoreJob` + +NewDiskBackupRestoreJobWithDefaults instantiates a new DiskBackupRestoreJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCancelled + +`func (o *DiskBackupRestoreJob) GetCancelled() bool` + +GetCancelled returns the Cancelled field if non-nil, zero value otherwise. + +### GetCancelledOk + +`func (o *DiskBackupRestoreJob) GetCancelledOk() (*bool, bool)` + +GetCancelledOk returns a tuple with the Cancelled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelled + +`func (o *DiskBackupRestoreJob) SetCancelled(v bool)` + +SetCancelled sets Cancelled field to given value. + +### HasCancelled + +`func (o *DiskBackupRestoreJob) HasCancelled() bool` + +HasCancelled returns a boolean if a field has been set. + +### GetComponents + +`func (o *DiskBackupRestoreJob) GetComponents() []DiskBackupBaseRestoreMember` + +GetComponents returns the Components field if non-nil, zero value otherwise. + +### GetComponentsOk + +`func (o *DiskBackupRestoreJob) GetComponentsOk() (*[]DiskBackupBaseRestoreMember, bool)` + +GetComponentsOk returns a tuple with the Components field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComponents + +`func (o *DiskBackupRestoreJob) SetComponents(v []DiskBackupBaseRestoreMember)` + +SetComponents sets Components field to given value. + +### HasComponents + +`func (o *DiskBackupRestoreJob) HasComponents() bool` + +HasComponents returns a boolean if a field has been set. + +### GetDeliveryType + +`func (o *DiskBackupRestoreJob) GetDeliveryType() string` + +GetDeliveryType returns the DeliveryType field if non-nil, zero value otherwise. + +### GetDeliveryTypeOk + +`func (o *DiskBackupRestoreJob) GetDeliveryTypeOk() (*string, bool)` + +GetDeliveryTypeOk returns a tuple with the DeliveryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryType + +`func (o *DiskBackupRestoreJob) SetDeliveryType(v string)` + +SetDeliveryType sets DeliveryType field to given value. + + +### GetDeliveryUrl + +`func (o *DiskBackupRestoreJob) GetDeliveryUrl() []string` + +GetDeliveryUrl returns the DeliveryUrl field if non-nil, zero value otherwise. + +### GetDeliveryUrlOk + +`func (o *DiskBackupRestoreJob) GetDeliveryUrlOk() (*[]string, bool)` + +GetDeliveryUrlOk returns a tuple with the DeliveryUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryUrl + +`func (o *DiskBackupRestoreJob) SetDeliveryUrl(v []string)` + +SetDeliveryUrl sets DeliveryUrl field to given value. + +### HasDeliveryUrl + +`func (o *DiskBackupRestoreJob) HasDeliveryUrl() bool` + +HasDeliveryUrl returns a boolean if a field has been set. + +### GetDesiredTimestamp + +`func (o *DiskBackupRestoreJob) GetDesiredTimestamp() BSONTimestamp` + +GetDesiredTimestamp returns the DesiredTimestamp field if non-nil, zero value otherwise. + +### GetDesiredTimestampOk + +`func (o *DiskBackupRestoreJob) GetDesiredTimestampOk() (*BSONTimestamp, bool)` + +GetDesiredTimestampOk returns a tuple with the DesiredTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDesiredTimestamp + +`func (o *DiskBackupRestoreJob) SetDesiredTimestamp(v BSONTimestamp)` + +SetDesiredTimestamp sets DesiredTimestamp field to given value. + +### HasDesiredTimestamp + +`func (o *DiskBackupRestoreJob) HasDesiredTimestamp() bool` + +HasDesiredTimestamp returns a boolean if a field has been set. + +### GetExpired + +`func (o *DiskBackupRestoreJob) GetExpired() bool` + +GetExpired returns the Expired field if non-nil, zero value otherwise. + +### GetExpiredOk + +`func (o *DiskBackupRestoreJob) GetExpiredOk() (*bool, bool)` + +GetExpiredOk returns a tuple with the Expired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpired + +`func (o *DiskBackupRestoreJob) SetExpired(v bool)` + +SetExpired sets Expired field to given value. + +### HasExpired + +`func (o *DiskBackupRestoreJob) HasExpired() bool` + +HasExpired returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *DiskBackupRestoreJob) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *DiskBackupRestoreJob) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *DiskBackupRestoreJob) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *DiskBackupRestoreJob) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetFailed + +`func (o *DiskBackupRestoreJob) GetFailed() bool` + +GetFailed returns the Failed field if non-nil, zero value otherwise. + +### GetFailedOk + +`func (o *DiskBackupRestoreJob) GetFailedOk() (*bool, bool)` + +GetFailedOk returns a tuple with the Failed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailed + +`func (o *DiskBackupRestoreJob) SetFailed(v bool)` + +SetFailed sets Failed field to given value. + +### HasFailed + +`func (o *DiskBackupRestoreJob) HasFailed() bool` + +HasFailed returns a boolean if a field has been set. + +### GetFinishedAt + +`func (o *DiskBackupRestoreJob) GetFinishedAt() time.Time` + +GetFinishedAt returns the FinishedAt field if non-nil, zero value otherwise. + +### GetFinishedAtOk + +`func (o *DiskBackupRestoreJob) GetFinishedAtOk() (*time.Time, bool)` + +GetFinishedAtOk returns a tuple with the FinishedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinishedAt + +`func (o *DiskBackupRestoreJob) SetFinishedAt(v time.Time)` + +SetFinishedAt sets FinishedAt field to given value. + +### HasFinishedAt + +`func (o *DiskBackupRestoreJob) HasFinishedAt() bool` + +HasFinishedAt returns a boolean if a field has been set. + +### GetId + +`func (o *DiskBackupRestoreJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DiskBackupRestoreJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DiskBackupRestoreJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DiskBackupRestoreJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupRestoreJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupRestoreJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupRestoreJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupRestoreJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOplogInc + +`func (o *DiskBackupRestoreJob) GetOplogInc() int` + +GetOplogInc returns the OplogInc field if non-nil, zero value otherwise. + +### GetOplogIncOk + +`func (o *DiskBackupRestoreJob) GetOplogIncOk() (*int, bool)` + +GetOplogIncOk returns a tuple with the OplogInc field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogInc + +`func (o *DiskBackupRestoreJob) SetOplogInc(v int)` + +SetOplogInc sets OplogInc field to given value. + +### HasOplogInc + +`func (o *DiskBackupRestoreJob) HasOplogInc() bool` + +HasOplogInc returns a boolean if a field has been set. + +### GetOplogTs + +`func (o *DiskBackupRestoreJob) GetOplogTs() int` + +GetOplogTs returns the OplogTs field if non-nil, zero value otherwise. + +### GetOplogTsOk + +`func (o *DiskBackupRestoreJob) GetOplogTsOk() (*int, bool)` + +GetOplogTsOk returns a tuple with the OplogTs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogTs + +`func (o *DiskBackupRestoreJob) SetOplogTs(v int)` + +SetOplogTs sets OplogTs field to given value. + +### HasOplogTs + +`func (o *DiskBackupRestoreJob) HasOplogTs() bool` + +HasOplogTs returns a boolean if a field has been set. + +### GetPointInTimeUTCSeconds + +`func (o *DiskBackupRestoreJob) GetPointInTimeUTCSeconds() int` + +GetPointInTimeUTCSeconds returns the PointInTimeUTCSeconds field if non-nil, zero value otherwise. + +### GetPointInTimeUTCSecondsOk + +`func (o *DiskBackupRestoreJob) GetPointInTimeUTCSecondsOk() (*int, bool)` + +GetPointInTimeUTCSecondsOk returns a tuple with the PointInTimeUTCSeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPointInTimeUTCSeconds + +`func (o *DiskBackupRestoreJob) SetPointInTimeUTCSeconds(v int)` + +SetPointInTimeUTCSeconds sets PointInTimeUTCSeconds field to given value. + +### HasPointInTimeUTCSeconds + +`func (o *DiskBackupRestoreJob) HasPointInTimeUTCSeconds() bool` + +HasPointInTimeUTCSeconds returns a boolean if a field has been set. + +### GetSnapshotId + +`func (o *DiskBackupRestoreJob) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *DiskBackupRestoreJob) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *DiskBackupRestoreJob) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + +### HasSnapshotId + +`func (o *DiskBackupRestoreJob) HasSnapshotId() bool` + +HasSnapshotId returns a boolean if a field has been set. + +### GetTargetClusterName + +`func (o *DiskBackupRestoreJob) GetTargetClusterName() string` + +GetTargetClusterName returns the TargetClusterName field if non-nil, zero value otherwise. + +### GetTargetClusterNameOk + +`func (o *DiskBackupRestoreJob) GetTargetClusterNameOk() (*string, bool)` + +GetTargetClusterNameOk returns a tuple with the TargetClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetClusterName + +`func (o *DiskBackupRestoreJob) SetTargetClusterName(v string)` + +SetTargetClusterName sets TargetClusterName field to given value. + + +### GetTargetGroupId + +`func (o *DiskBackupRestoreJob) GetTargetGroupId() string` + +GetTargetGroupId returns the TargetGroupId field if non-nil, zero value otherwise. + +### GetTargetGroupIdOk + +`func (o *DiskBackupRestoreJob) GetTargetGroupIdOk() (*string, bool)` + +GetTargetGroupIdOk returns a tuple with the TargetGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetGroupId + +`func (o *DiskBackupRestoreJob) SetTargetGroupId(v string)` + +SetTargetGroupId sets TargetGroupId field to given value. + + +### GetTimestamp + +`func (o *DiskBackupRestoreJob) GetTimestamp() time.Time` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *DiskBackupRestoreJob) GetTimestampOk() (*time.Time, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *DiskBackupRestoreJob) SetTimestamp(v time.Time)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *DiskBackupRestoreJob) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupShardedClusterSnapshot.md b/docs/docs/DiskBackupShardedClusterSnapshot.md new file mode 100644 index 00000000..5311e779 --- /dev/null +++ b/docs/docs/DiskBackupShardedClusterSnapshot.md @@ -0,0 +1,420 @@ +# DiskBackupShardedClusterSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Description** | Pointer to **string** | Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FrequencyType** | Pointer to **string** | Human-readable label that identifies how often this snapshot triggers. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the snapshot. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MasterKeyUUID** | Pointer to **string** | Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`. | [optional] [readonly] +**Members** | Pointer to [**[]DiskBackupShardedClusterSnapshotMember**](DiskBackupShardedClusterSnapshotMember.md) | List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`. | [optional] [readonly] +**MongodVersion** | Pointer to **string** | Version of the MongoDB host that this snapshot backs up. | [optional] [readonly] +**PolicyItems** | Pointer to **[]string** | List that contains unique identifiers for the policy items. | [optional] [readonly] +**SnapshotIds** | Pointer to **[]string** | List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name. | [optional] [readonly] +**SnapshotType** | Pointer to **string** | Human-readable label that identifies when this snapshot triggers. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable label that indicates the stage of the backup process for this snapshot. | [optional] [readonly] +**StorageSizeBytes** | Pointer to **int64** | Number of bytes taken to store the backup snapshot. | [optional] [readonly] +**Type** | Pointer to **string** | Human-readable label that categorizes the cluster as a replica set or sharded cluster. | [optional] [readonly] + +## Methods + +### NewDiskBackupShardedClusterSnapshot + +`func NewDiskBackupShardedClusterSnapshot() *DiskBackupShardedClusterSnapshot` + +NewDiskBackupShardedClusterSnapshot instantiates a new DiskBackupShardedClusterSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupShardedClusterSnapshotWithDefaults + +`func NewDiskBackupShardedClusterSnapshotWithDefaults() *DiskBackupShardedClusterSnapshot` + +NewDiskBackupShardedClusterSnapshotWithDefaults instantiates a new DiskBackupShardedClusterSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreatedAt + +`func (o *DiskBackupShardedClusterSnapshot) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *DiskBackupShardedClusterSnapshot) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *DiskBackupShardedClusterSnapshot) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *DiskBackupShardedClusterSnapshot) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetDescription + +`func (o *DiskBackupShardedClusterSnapshot) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DiskBackupShardedClusterSnapshot) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DiskBackupShardedClusterSnapshot) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DiskBackupShardedClusterSnapshot) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *DiskBackupShardedClusterSnapshot) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *DiskBackupShardedClusterSnapshot) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *DiskBackupShardedClusterSnapshot) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *DiskBackupShardedClusterSnapshot) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetFrequencyType + +`func (o *DiskBackupShardedClusterSnapshot) GetFrequencyType() string` + +GetFrequencyType returns the FrequencyType field if non-nil, zero value otherwise. + +### GetFrequencyTypeOk + +`func (o *DiskBackupShardedClusterSnapshot) GetFrequencyTypeOk() (*string, bool)` + +GetFrequencyTypeOk returns a tuple with the FrequencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencyType + +`func (o *DiskBackupShardedClusterSnapshot) SetFrequencyType(v string)` + +SetFrequencyType sets FrequencyType field to given value. + +### HasFrequencyType + +`func (o *DiskBackupShardedClusterSnapshot) HasFrequencyType() bool` + +HasFrequencyType returns a boolean if a field has been set. + +### GetId + +`func (o *DiskBackupShardedClusterSnapshot) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DiskBackupShardedClusterSnapshot) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DiskBackupShardedClusterSnapshot) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DiskBackupShardedClusterSnapshot) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupShardedClusterSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupShardedClusterSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupShardedClusterSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupShardedClusterSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMasterKeyUUID + +`func (o *DiskBackupShardedClusterSnapshot) GetMasterKeyUUID() string` + +GetMasterKeyUUID returns the MasterKeyUUID field if non-nil, zero value otherwise. + +### GetMasterKeyUUIDOk + +`func (o *DiskBackupShardedClusterSnapshot) GetMasterKeyUUIDOk() (*string, bool)` + +GetMasterKeyUUIDOk returns a tuple with the MasterKeyUUID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMasterKeyUUID + +`func (o *DiskBackupShardedClusterSnapshot) SetMasterKeyUUID(v string)` + +SetMasterKeyUUID sets MasterKeyUUID field to given value. + +### HasMasterKeyUUID + +`func (o *DiskBackupShardedClusterSnapshot) HasMasterKeyUUID() bool` + +HasMasterKeyUUID returns a boolean if a field has been set. + +### GetMembers + +`func (o *DiskBackupShardedClusterSnapshot) GetMembers() []DiskBackupShardedClusterSnapshotMember` + +GetMembers returns the Members field if non-nil, zero value otherwise. + +### GetMembersOk + +`func (o *DiskBackupShardedClusterSnapshot) GetMembersOk() (*[]DiskBackupShardedClusterSnapshotMember, bool)` + +GetMembersOk returns a tuple with the Members field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembers + +`func (o *DiskBackupShardedClusterSnapshot) SetMembers(v []DiskBackupShardedClusterSnapshotMember)` + +SetMembers sets Members field to given value. + +### HasMembers + +`func (o *DiskBackupShardedClusterSnapshot) HasMembers() bool` + +HasMembers returns a boolean if a field has been set. + +### GetMongodVersion + +`func (o *DiskBackupShardedClusterSnapshot) GetMongodVersion() string` + +GetMongodVersion returns the MongodVersion field if non-nil, zero value otherwise. + +### GetMongodVersionOk + +`func (o *DiskBackupShardedClusterSnapshot) GetMongodVersionOk() (*string, bool)` + +GetMongodVersionOk returns a tuple with the MongodVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongodVersion + +`func (o *DiskBackupShardedClusterSnapshot) SetMongodVersion(v string)` + +SetMongodVersion sets MongodVersion field to given value. + +### HasMongodVersion + +`func (o *DiskBackupShardedClusterSnapshot) HasMongodVersion() bool` + +HasMongodVersion returns a boolean if a field has been set. + +### GetPolicyItems + +`func (o *DiskBackupShardedClusterSnapshot) GetPolicyItems() []string` + +GetPolicyItems returns the PolicyItems field if non-nil, zero value otherwise. + +### GetPolicyItemsOk + +`func (o *DiskBackupShardedClusterSnapshot) GetPolicyItemsOk() (*[]string, bool)` + +GetPolicyItemsOk returns a tuple with the PolicyItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyItems + +`func (o *DiskBackupShardedClusterSnapshot) SetPolicyItems(v []string)` + +SetPolicyItems sets PolicyItems field to given value. + +### HasPolicyItems + +`func (o *DiskBackupShardedClusterSnapshot) HasPolicyItems() bool` + +HasPolicyItems returns a boolean if a field has been set. + +### GetSnapshotIds + +`func (o *DiskBackupShardedClusterSnapshot) GetSnapshotIds() []string` + +GetSnapshotIds returns the SnapshotIds field if non-nil, zero value otherwise. + +### GetSnapshotIdsOk + +`func (o *DiskBackupShardedClusterSnapshot) GetSnapshotIdsOk() (*[]string, bool)` + +GetSnapshotIdsOk returns a tuple with the SnapshotIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotIds + +`func (o *DiskBackupShardedClusterSnapshot) SetSnapshotIds(v []string)` + +SetSnapshotIds sets SnapshotIds field to given value. + +### HasSnapshotIds + +`func (o *DiskBackupShardedClusterSnapshot) HasSnapshotIds() bool` + +HasSnapshotIds returns a boolean if a field has been set. + +### GetSnapshotType + +`func (o *DiskBackupShardedClusterSnapshot) GetSnapshotType() string` + +GetSnapshotType returns the SnapshotType field if non-nil, zero value otherwise. + +### GetSnapshotTypeOk + +`func (o *DiskBackupShardedClusterSnapshot) GetSnapshotTypeOk() (*string, bool)` + +GetSnapshotTypeOk returns a tuple with the SnapshotType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotType + +`func (o *DiskBackupShardedClusterSnapshot) SetSnapshotType(v string)` + +SetSnapshotType sets SnapshotType field to given value. + +### HasSnapshotType + +`func (o *DiskBackupShardedClusterSnapshot) HasSnapshotType() bool` + +HasSnapshotType returns a boolean if a field has been set. + +### GetStatus + +`func (o *DiskBackupShardedClusterSnapshot) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DiskBackupShardedClusterSnapshot) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DiskBackupShardedClusterSnapshot) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *DiskBackupShardedClusterSnapshot) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStorageSizeBytes + +`func (o *DiskBackupShardedClusterSnapshot) GetStorageSizeBytes() int64` + +GetStorageSizeBytes returns the StorageSizeBytes field if non-nil, zero value otherwise. + +### GetStorageSizeBytesOk + +`func (o *DiskBackupShardedClusterSnapshot) GetStorageSizeBytesOk() (*int64, bool)` + +GetStorageSizeBytesOk returns a tuple with the StorageSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageSizeBytes + +`func (o *DiskBackupShardedClusterSnapshot) SetStorageSizeBytes(v int64)` + +SetStorageSizeBytes sets StorageSizeBytes field to given value. + +### HasStorageSizeBytes + +`func (o *DiskBackupShardedClusterSnapshot) HasStorageSizeBytes() bool` + +HasStorageSizeBytes returns a boolean if a field has been set. + +### GetType + +`func (o *DiskBackupShardedClusterSnapshot) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DiskBackupShardedClusterSnapshot) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DiskBackupShardedClusterSnapshot) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DiskBackupShardedClusterSnapshot) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupShardedClusterSnapshotMember.md b/docs/docs/DiskBackupShardedClusterSnapshotMember.md new file mode 100644 index 00000000..24904b08 --- /dev/null +++ b/docs/docs/DiskBackupShardedClusterSnapshotMember.md @@ -0,0 +1,93 @@ +# DiskBackupShardedClusterSnapshotMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProvider** | **string** | Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`. | [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the snapshot. | [readonly] +**ReplicaSetName** | **string** | Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot. | [readonly] + +## Methods + +### NewDiskBackupShardedClusterSnapshotMember + +`func NewDiskBackupShardedClusterSnapshotMember(cloudProvider string, id string, replicaSetName string, ) *DiskBackupShardedClusterSnapshotMember` + +NewDiskBackupShardedClusterSnapshotMember instantiates a new DiskBackupShardedClusterSnapshotMember object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupShardedClusterSnapshotMemberWithDefaults + +`func NewDiskBackupShardedClusterSnapshotMemberWithDefaults() *DiskBackupShardedClusterSnapshotMember` + +NewDiskBackupShardedClusterSnapshotMemberWithDefaults instantiates a new DiskBackupShardedClusterSnapshotMember object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProvider + +`func (o *DiskBackupShardedClusterSnapshotMember) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *DiskBackupShardedClusterSnapshotMember) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *DiskBackupShardedClusterSnapshotMember) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + + +### GetId + +`func (o *DiskBackupShardedClusterSnapshotMember) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DiskBackupShardedClusterSnapshotMember) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DiskBackupShardedClusterSnapshotMember) SetId(v string)` + +SetId sets Id field to given value. + + +### GetReplicaSetName + +`func (o *DiskBackupShardedClusterSnapshotMember) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *DiskBackupShardedClusterSnapshotMember) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *DiskBackupShardedClusterSnapshotMember) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupSnapshot.md b/docs/docs/DiskBackupSnapshot.md new file mode 100644 index 00000000..3fe7045b --- /dev/null +++ b/docs/docs/DiskBackupSnapshot.md @@ -0,0 +1,498 @@ +# DiskBackupSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProvider** | Pointer to **string** | Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`. | [optional] [readonly] +**CopyRegions** | Pointer to **[]string** | List that identifies the regions to which MongoDB Cloud copies the snapshot. | [optional] [readonly] +**CreatedAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Description** | Pointer to **string** | Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FrequencyType** | Pointer to **string** | Human-readable label that identifies how often this snapshot triggers. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the snapshot. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MasterKeyUUID** | Pointer to **string** | Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`. | [optional] [readonly] +**MongodVersion** | Pointer to **string** | Version of the MongoDB host that this snapshot backs up. | [optional] [readonly] +**PolicyItems** | Pointer to **[]string** | List that contains unique identifiers for the policy items. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`. | [optional] [readonly] +**SnapshotType** | Pointer to **string** | Human-readable label that identifies when this snapshot triggers. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable label that indicates the stage of the backup process for this snapshot. | [optional] [readonly] +**StorageSizeBytes** | Pointer to **int64** | Number of bytes taken to store the backup snapshot. | [optional] [readonly] +**Type** | Pointer to **string** | Human-readable label that categorizes the cluster as a replica set or sharded cluster. | [optional] [readonly] +**Members** | Pointer to [**[]DiskBackupShardedClusterSnapshotMember**](DiskBackupShardedClusterSnapshotMember.md) | List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`. | [optional] [readonly] +**SnapshotIds** | Pointer to **[]string** | List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name. | [optional] [readonly] + +## Methods + +### NewDiskBackupSnapshot + +`func NewDiskBackupSnapshot() *DiskBackupSnapshot` + +NewDiskBackupSnapshot instantiates a new DiskBackupSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupSnapshotWithDefaults + +`func NewDiskBackupSnapshotWithDefaults() *DiskBackupSnapshot` + +NewDiskBackupSnapshotWithDefaults instantiates a new DiskBackupSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProvider + +`func (o *DiskBackupSnapshot) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *DiskBackupSnapshot) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *DiskBackupSnapshot) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + +### HasCloudProvider + +`func (o *DiskBackupSnapshot) HasCloudProvider() bool` + +HasCloudProvider returns a boolean if a field has been set. + +### GetCopyRegions + +`func (o *DiskBackupSnapshot) GetCopyRegions() []string` + +GetCopyRegions returns the CopyRegions field if non-nil, zero value otherwise. + +### GetCopyRegionsOk + +`func (o *DiskBackupSnapshot) GetCopyRegionsOk() (*[]string, bool)` + +GetCopyRegionsOk returns a tuple with the CopyRegions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCopyRegions + +`func (o *DiskBackupSnapshot) SetCopyRegions(v []string)` + +SetCopyRegions sets CopyRegions field to given value. + +### HasCopyRegions + +`func (o *DiskBackupSnapshot) HasCopyRegions() bool` + +HasCopyRegions returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *DiskBackupSnapshot) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *DiskBackupSnapshot) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *DiskBackupSnapshot) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *DiskBackupSnapshot) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetDescription + +`func (o *DiskBackupSnapshot) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DiskBackupSnapshot) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DiskBackupSnapshot) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DiskBackupSnapshot) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *DiskBackupSnapshot) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *DiskBackupSnapshot) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *DiskBackupSnapshot) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *DiskBackupSnapshot) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetFrequencyType + +`func (o *DiskBackupSnapshot) GetFrequencyType() string` + +GetFrequencyType returns the FrequencyType field if non-nil, zero value otherwise. + +### GetFrequencyTypeOk + +`func (o *DiskBackupSnapshot) GetFrequencyTypeOk() (*string, bool)` + +GetFrequencyTypeOk returns a tuple with the FrequencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencyType + +`func (o *DiskBackupSnapshot) SetFrequencyType(v string)` + +SetFrequencyType sets FrequencyType field to given value. + +### HasFrequencyType + +`func (o *DiskBackupSnapshot) HasFrequencyType() bool` + +HasFrequencyType returns a boolean if a field has been set. + +### GetId + +`func (o *DiskBackupSnapshot) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DiskBackupSnapshot) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DiskBackupSnapshot) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DiskBackupSnapshot) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMasterKeyUUID + +`func (o *DiskBackupSnapshot) GetMasterKeyUUID() string` + +GetMasterKeyUUID returns the MasterKeyUUID field if non-nil, zero value otherwise. + +### GetMasterKeyUUIDOk + +`func (o *DiskBackupSnapshot) GetMasterKeyUUIDOk() (*string, bool)` + +GetMasterKeyUUIDOk returns a tuple with the MasterKeyUUID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMasterKeyUUID + +`func (o *DiskBackupSnapshot) SetMasterKeyUUID(v string)` + +SetMasterKeyUUID sets MasterKeyUUID field to given value. + +### HasMasterKeyUUID + +`func (o *DiskBackupSnapshot) HasMasterKeyUUID() bool` + +HasMasterKeyUUID returns a boolean if a field has been set. + +### GetMongodVersion + +`func (o *DiskBackupSnapshot) GetMongodVersion() string` + +GetMongodVersion returns the MongodVersion field if non-nil, zero value otherwise. + +### GetMongodVersionOk + +`func (o *DiskBackupSnapshot) GetMongodVersionOk() (*string, bool)` + +GetMongodVersionOk returns a tuple with the MongodVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongodVersion + +`func (o *DiskBackupSnapshot) SetMongodVersion(v string)` + +SetMongodVersion sets MongodVersion field to given value. + +### HasMongodVersion + +`func (o *DiskBackupSnapshot) HasMongodVersion() bool` + +HasMongodVersion returns a boolean if a field has been set. + +### GetPolicyItems + +`func (o *DiskBackupSnapshot) GetPolicyItems() []string` + +GetPolicyItems returns the PolicyItems field if non-nil, zero value otherwise. + +### GetPolicyItemsOk + +`func (o *DiskBackupSnapshot) GetPolicyItemsOk() (*[]string, bool)` + +GetPolicyItemsOk returns a tuple with the PolicyItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyItems + +`func (o *DiskBackupSnapshot) SetPolicyItems(v []string)` + +SetPolicyItems sets PolicyItems field to given value. + +### HasPolicyItems + +`func (o *DiskBackupSnapshot) HasPolicyItems() bool` + +HasPolicyItems returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *DiskBackupSnapshot) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *DiskBackupSnapshot) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *DiskBackupSnapshot) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *DiskBackupSnapshot) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetSnapshotType + +`func (o *DiskBackupSnapshot) GetSnapshotType() string` + +GetSnapshotType returns the SnapshotType field if non-nil, zero value otherwise. + +### GetSnapshotTypeOk + +`func (o *DiskBackupSnapshot) GetSnapshotTypeOk() (*string, bool)` + +GetSnapshotTypeOk returns a tuple with the SnapshotType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotType + +`func (o *DiskBackupSnapshot) SetSnapshotType(v string)` + +SetSnapshotType sets SnapshotType field to given value. + +### HasSnapshotType + +`func (o *DiskBackupSnapshot) HasSnapshotType() bool` + +HasSnapshotType returns a boolean if a field has been set. + +### GetStatus + +`func (o *DiskBackupSnapshot) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DiskBackupSnapshot) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DiskBackupSnapshot) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *DiskBackupSnapshot) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStorageSizeBytes + +`func (o *DiskBackupSnapshot) GetStorageSizeBytes() int64` + +GetStorageSizeBytes returns the StorageSizeBytes field if non-nil, zero value otherwise. + +### GetStorageSizeBytesOk + +`func (o *DiskBackupSnapshot) GetStorageSizeBytesOk() (*int64, bool)` + +GetStorageSizeBytesOk returns a tuple with the StorageSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageSizeBytes + +`func (o *DiskBackupSnapshot) SetStorageSizeBytes(v int64)` + +SetStorageSizeBytes sets StorageSizeBytes field to given value. + +### HasStorageSizeBytes + +`func (o *DiskBackupSnapshot) HasStorageSizeBytes() bool` + +HasStorageSizeBytes returns a boolean if a field has been set. + +### GetType + +`func (o *DiskBackupSnapshot) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DiskBackupSnapshot) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DiskBackupSnapshot) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DiskBackupSnapshot) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetMembers + +`func (o *DiskBackupSnapshot) GetMembers() []DiskBackupShardedClusterSnapshotMember` + +GetMembers returns the Members field if non-nil, zero value otherwise. + +### GetMembersOk + +`func (o *DiskBackupSnapshot) GetMembersOk() (*[]DiskBackupShardedClusterSnapshotMember, bool)` + +GetMembersOk returns a tuple with the Members field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembers + +`func (o *DiskBackupSnapshot) SetMembers(v []DiskBackupShardedClusterSnapshotMember)` + +SetMembers sets Members field to given value. + +### HasMembers + +`func (o *DiskBackupSnapshot) HasMembers() bool` + +HasMembers returns a boolean if a field has been set. + +### GetSnapshotIds + +`func (o *DiskBackupSnapshot) GetSnapshotIds() []string` + +GetSnapshotIds returns the SnapshotIds field if non-nil, zero value otherwise. + +### GetSnapshotIdsOk + +`func (o *DiskBackupSnapshot) GetSnapshotIdsOk() (*[]string, bool)` + +GetSnapshotIdsOk returns a tuple with the SnapshotIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotIds + +`func (o *DiskBackupSnapshot) SetSnapshotIds(v []string)` + +SetSnapshotIds sets SnapshotIds field to given value. + +### HasSnapshotIds + +`func (o *DiskBackupSnapshot) HasSnapshotIds() bool` + +HasSnapshotIds returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupSnapshotAWSExportBucket.md b/docs/docs/DiskBackupSnapshotAWSExportBucket.md new file mode 100644 index 00000000..031c7ce1 --- /dev/null +++ b/docs/docs/DiskBackupSnapshotAWSExportBucket.md @@ -0,0 +1,160 @@ +# DiskBackupSnapshotAWSExportBucket + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket. | [optional] [readonly] +**BucketName** | Pointer to **string** | Human-readable label that identifies the AWS bucket that the role is authorized to access. | [optional] +**CloudProvider** | Pointer to **string** | Human-readable label that identifies the cloud provider that stores this snapshot. | [optional] +**IamRoleId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the AWS IAM role that MongoDB Cloud uses to access the AWS S3 bucket. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewDiskBackupSnapshotAWSExportBucket + +`func NewDiskBackupSnapshotAWSExportBucket() *DiskBackupSnapshotAWSExportBucket` + +NewDiskBackupSnapshotAWSExportBucket instantiates a new DiskBackupSnapshotAWSExportBucket object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupSnapshotAWSExportBucketWithDefaults + +`func NewDiskBackupSnapshotAWSExportBucketWithDefaults() *DiskBackupSnapshotAWSExportBucket` + +NewDiskBackupSnapshotAWSExportBucketWithDefaults instantiates a new DiskBackupSnapshotAWSExportBucket object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *DiskBackupSnapshotAWSExportBucket) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DiskBackupSnapshotAWSExportBucket) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DiskBackupSnapshotAWSExportBucket) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DiskBackupSnapshotAWSExportBucket) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetBucketName + +`func (o *DiskBackupSnapshotAWSExportBucket) GetBucketName() string` + +GetBucketName returns the BucketName field if non-nil, zero value otherwise. + +### GetBucketNameOk + +`func (o *DiskBackupSnapshotAWSExportBucket) GetBucketNameOk() (*string, bool)` + +GetBucketNameOk returns a tuple with the BucketName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucketName + +`func (o *DiskBackupSnapshotAWSExportBucket) SetBucketName(v string)` + +SetBucketName sets BucketName field to given value. + +### HasBucketName + +`func (o *DiskBackupSnapshotAWSExportBucket) HasBucketName() bool` + +HasBucketName returns a boolean if a field has been set. + +### GetCloudProvider + +`func (o *DiskBackupSnapshotAWSExportBucket) GetCloudProvider() string` + +GetCloudProvider returns the CloudProvider field if non-nil, zero value otherwise. + +### GetCloudProviderOk + +`func (o *DiskBackupSnapshotAWSExportBucket) GetCloudProviderOk() (*string, bool)` + +GetCloudProviderOk returns a tuple with the CloudProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProvider + +`func (o *DiskBackupSnapshotAWSExportBucket) SetCloudProvider(v string)` + +SetCloudProvider sets CloudProvider field to given value. + +### HasCloudProvider + +`func (o *DiskBackupSnapshotAWSExportBucket) HasCloudProvider() bool` + +HasCloudProvider returns a boolean if a field has been set. + +### GetIamRoleId + +`func (o *DiskBackupSnapshotAWSExportBucket) GetIamRoleId() string` + +GetIamRoleId returns the IamRoleId field if non-nil, zero value otherwise. + +### GetIamRoleIdOk + +`func (o *DiskBackupSnapshotAWSExportBucket) GetIamRoleIdOk() (*string, bool)` + +GetIamRoleIdOk returns a tuple with the IamRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIamRoleId + +`func (o *DiskBackupSnapshotAWSExportBucket) SetIamRoleId(v string)` + +SetIamRoleId sets IamRoleId field to given value. + +### HasIamRoleId + +`func (o *DiskBackupSnapshotAWSExportBucket) HasIamRoleId() bool` + +HasIamRoleId returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupSnapshotAWSExportBucket) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupSnapshotAWSExportBucket) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupSnapshotAWSExportBucket) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupSnapshotAWSExportBucket) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskBackupSnapshotSchedule.md b/docs/docs/DiskBackupSnapshotSchedule.md new file mode 100644 index 00000000..2089004d --- /dev/null +++ b/docs/docs/DiskBackupSnapshotSchedule.md @@ -0,0 +1,394 @@ +# DiskBackupSnapshotSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoExportEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud automatically exports cloud backup snapshots to the AWS bucket. | [optional] +**ClusterId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. | [optional] [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster with the snapshot you want to return. | [optional] [readonly] +**CopySettings** | Pointer to [**[]DiskBackupCopySetting**](DiskBackupCopySetting.md) | List that contains a document for each copy setting item in the desired backup policy. | [optional] +**DeleteCopiedBackups** | Pointer to [**[]DeleteCopiedBackups**](DeleteCopiedBackups.md) | List that contains a document for each deleted copy setting whose backup copies you want to delete. | [optional] +**Export** | Pointer to [**AutoExportPolicy**](AutoExportPolicy.md) | | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**NextSnapshot** | Pointer to **time.Time** | Date and time when MongoDB Cloud takes the next snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Policies** | Pointer to [**[]Policy**](Policy.md) | Rules set for this backup schedule. | [optional] +**ReferenceHourOfDay** | Pointer to **int** | Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the snapshot. | [optional] +**ReferenceMinuteOfHour** | Pointer to **int** | Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the snapshot. | [optional] +**RestoreWindowDays** | Pointer to **int** | Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous cloud backups only. | [optional] +**UpdateSnapshots** | Pointer to **bool** | Flag that indicates whether to apply the retention changes in the updated backup policy to snapshots that MongoDB Cloud took previously. | [optional] +**UseOrgAndGroupNamesInExportPrefix** | Pointer to **bool** | Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your AWS bucket. | [optional] + +## Methods + +### NewDiskBackupSnapshotSchedule + +`func NewDiskBackupSnapshotSchedule() *DiskBackupSnapshotSchedule` + +NewDiskBackupSnapshotSchedule instantiates a new DiskBackupSnapshotSchedule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskBackupSnapshotScheduleWithDefaults + +`func NewDiskBackupSnapshotScheduleWithDefaults() *DiskBackupSnapshotSchedule` + +NewDiskBackupSnapshotScheduleWithDefaults instantiates a new DiskBackupSnapshotSchedule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoExportEnabled + +`func (o *DiskBackupSnapshotSchedule) GetAutoExportEnabled() bool` + +GetAutoExportEnabled returns the AutoExportEnabled field if non-nil, zero value otherwise. + +### GetAutoExportEnabledOk + +`func (o *DiskBackupSnapshotSchedule) GetAutoExportEnabledOk() (*bool, bool)` + +GetAutoExportEnabledOk returns a tuple with the AutoExportEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoExportEnabled + +`func (o *DiskBackupSnapshotSchedule) SetAutoExportEnabled(v bool)` + +SetAutoExportEnabled sets AutoExportEnabled field to given value. + +### HasAutoExportEnabled + +`func (o *DiskBackupSnapshotSchedule) HasAutoExportEnabled() bool` + +HasAutoExportEnabled returns a boolean if a field has been set. + +### GetClusterId + +`func (o *DiskBackupSnapshotSchedule) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *DiskBackupSnapshotSchedule) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *DiskBackupSnapshotSchedule) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + +### HasClusterId + +`func (o *DiskBackupSnapshotSchedule) HasClusterId() bool` + +HasClusterId returns a boolean if a field has been set. + +### GetClusterName + +`func (o *DiskBackupSnapshotSchedule) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *DiskBackupSnapshotSchedule) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *DiskBackupSnapshotSchedule) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *DiskBackupSnapshotSchedule) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCopySettings + +`func (o *DiskBackupSnapshotSchedule) GetCopySettings() []DiskBackupCopySetting` + +GetCopySettings returns the CopySettings field if non-nil, zero value otherwise. + +### GetCopySettingsOk + +`func (o *DiskBackupSnapshotSchedule) GetCopySettingsOk() (*[]DiskBackupCopySetting, bool)` + +GetCopySettingsOk returns a tuple with the CopySettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCopySettings + +`func (o *DiskBackupSnapshotSchedule) SetCopySettings(v []DiskBackupCopySetting)` + +SetCopySettings sets CopySettings field to given value. + +### HasCopySettings + +`func (o *DiskBackupSnapshotSchedule) HasCopySettings() bool` + +HasCopySettings returns a boolean if a field has been set. + +### GetDeleteCopiedBackups + +`func (o *DiskBackupSnapshotSchedule) GetDeleteCopiedBackups() []DeleteCopiedBackups` + +GetDeleteCopiedBackups returns the DeleteCopiedBackups field if non-nil, zero value otherwise. + +### GetDeleteCopiedBackupsOk + +`func (o *DiskBackupSnapshotSchedule) GetDeleteCopiedBackupsOk() (*[]DeleteCopiedBackups, bool)` + +GetDeleteCopiedBackupsOk returns a tuple with the DeleteCopiedBackups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteCopiedBackups + +`func (o *DiskBackupSnapshotSchedule) SetDeleteCopiedBackups(v []DeleteCopiedBackups)` + +SetDeleteCopiedBackups sets DeleteCopiedBackups field to given value. + +### HasDeleteCopiedBackups + +`func (o *DiskBackupSnapshotSchedule) HasDeleteCopiedBackups() bool` + +HasDeleteCopiedBackups returns a boolean if a field has been set. + +### GetExport + +`func (o *DiskBackupSnapshotSchedule) GetExport() AutoExportPolicy` + +GetExport returns the Export field if non-nil, zero value otherwise. + +### GetExportOk + +`func (o *DiskBackupSnapshotSchedule) GetExportOk() (*AutoExportPolicy, bool)` + +GetExportOk returns a tuple with the Export field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExport + +`func (o *DiskBackupSnapshotSchedule) SetExport(v AutoExportPolicy)` + +SetExport sets Export field to given value. + +### HasExport + +`func (o *DiskBackupSnapshotSchedule) HasExport() bool` + +HasExport returns a boolean if a field has been set. + +### GetLinks + +`func (o *DiskBackupSnapshotSchedule) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskBackupSnapshotSchedule) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskBackupSnapshotSchedule) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskBackupSnapshotSchedule) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetNextSnapshot + +`func (o *DiskBackupSnapshotSchedule) GetNextSnapshot() time.Time` + +GetNextSnapshot returns the NextSnapshot field if non-nil, zero value otherwise. + +### GetNextSnapshotOk + +`func (o *DiskBackupSnapshotSchedule) GetNextSnapshotOk() (*time.Time, bool)` + +GetNextSnapshotOk returns a tuple with the NextSnapshot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNextSnapshot + +`func (o *DiskBackupSnapshotSchedule) SetNextSnapshot(v time.Time)` + +SetNextSnapshot sets NextSnapshot field to given value. + +### HasNextSnapshot + +`func (o *DiskBackupSnapshotSchedule) HasNextSnapshot() bool` + +HasNextSnapshot returns a boolean if a field has been set. + +### GetPolicies + +`func (o *DiskBackupSnapshotSchedule) GetPolicies() []Policy` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *DiskBackupSnapshotSchedule) GetPoliciesOk() (*[]Policy, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *DiskBackupSnapshotSchedule) SetPolicies(v []Policy)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *DiskBackupSnapshotSchedule) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + +### GetReferenceHourOfDay + +`func (o *DiskBackupSnapshotSchedule) GetReferenceHourOfDay() int` + +GetReferenceHourOfDay returns the ReferenceHourOfDay field if non-nil, zero value otherwise. + +### GetReferenceHourOfDayOk + +`func (o *DiskBackupSnapshotSchedule) GetReferenceHourOfDayOk() (*int, bool)` + +GetReferenceHourOfDayOk returns a tuple with the ReferenceHourOfDay field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceHourOfDay + +`func (o *DiskBackupSnapshotSchedule) SetReferenceHourOfDay(v int)` + +SetReferenceHourOfDay sets ReferenceHourOfDay field to given value. + +### HasReferenceHourOfDay + +`func (o *DiskBackupSnapshotSchedule) HasReferenceHourOfDay() bool` + +HasReferenceHourOfDay returns a boolean if a field has been set. + +### GetReferenceMinuteOfHour + +`func (o *DiskBackupSnapshotSchedule) GetReferenceMinuteOfHour() int` + +GetReferenceMinuteOfHour returns the ReferenceMinuteOfHour field if non-nil, zero value otherwise. + +### GetReferenceMinuteOfHourOk + +`func (o *DiskBackupSnapshotSchedule) GetReferenceMinuteOfHourOk() (*int, bool)` + +GetReferenceMinuteOfHourOk returns a tuple with the ReferenceMinuteOfHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceMinuteOfHour + +`func (o *DiskBackupSnapshotSchedule) SetReferenceMinuteOfHour(v int)` + +SetReferenceMinuteOfHour sets ReferenceMinuteOfHour field to given value. + +### HasReferenceMinuteOfHour + +`func (o *DiskBackupSnapshotSchedule) HasReferenceMinuteOfHour() bool` + +HasReferenceMinuteOfHour returns a boolean if a field has been set. + +### GetRestoreWindowDays + +`func (o *DiskBackupSnapshotSchedule) GetRestoreWindowDays() int` + +GetRestoreWindowDays returns the RestoreWindowDays field if non-nil, zero value otherwise. + +### GetRestoreWindowDaysOk + +`func (o *DiskBackupSnapshotSchedule) GetRestoreWindowDaysOk() (*int, bool)` + +GetRestoreWindowDaysOk returns a tuple with the RestoreWindowDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestoreWindowDays + +`func (o *DiskBackupSnapshotSchedule) SetRestoreWindowDays(v int)` + +SetRestoreWindowDays sets RestoreWindowDays field to given value. + +### HasRestoreWindowDays + +`func (o *DiskBackupSnapshotSchedule) HasRestoreWindowDays() bool` + +HasRestoreWindowDays returns a boolean if a field has been set. + +### GetUpdateSnapshots + +`func (o *DiskBackupSnapshotSchedule) GetUpdateSnapshots() bool` + +GetUpdateSnapshots returns the UpdateSnapshots field if non-nil, zero value otherwise. + +### GetUpdateSnapshotsOk + +`func (o *DiskBackupSnapshotSchedule) GetUpdateSnapshotsOk() (*bool, bool)` + +GetUpdateSnapshotsOk returns a tuple with the UpdateSnapshots field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdateSnapshots + +`func (o *DiskBackupSnapshotSchedule) SetUpdateSnapshots(v bool)` + +SetUpdateSnapshots sets UpdateSnapshots field to given value. + +### HasUpdateSnapshots + +`func (o *DiskBackupSnapshotSchedule) HasUpdateSnapshots() bool` + +HasUpdateSnapshots returns a boolean if a field has been set. + +### GetUseOrgAndGroupNamesInExportPrefix + +`func (o *DiskBackupSnapshotSchedule) GetUseOrgAndGroupNamesInExportPrefix() bool` + +GetUseOrgAndGroupNamesInExportPrefix returns the UseOrgAndGroupNamesInExportPrefix field if non-nil, zero value otherwise. + +### GetUseOrgAndGroupNamesInExportPrefixOk + +`func (o *DiskBackupSnapshotSchedule) GetUseOrgAndGroupNamesInExportPrefixOk() (*bool, bool)` + +GetUseOrgAndGroupNamesInExportPrefixOk returns a tuple with the UseOrgAndGroupNamesInExportPrefix field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseOrgAndGroupNamesInExportPrefix + +`func (o *DiskBackupSnapshotSchedule) SetUseOrgAndGroupNamesInExportPrefix(v bool)` + +SetUseOrgAndGroupNamesInExportPrefix sets UseOrgAndGroupNamesInExportPrefix field to given value. + +### HasUseOrgAndGroupNamesInExportPrefix + +`func (o *DiskBackupSnapshotSchedule) HasUseOrgAndGroupNamesInExportPrefix() bool` + +HasUseOrgAndGroupNamesInExportPrefix returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskGBAutoScaling.md b/docs/docs/DiskGBAutoScaling.md new file mode 100644 index 00000000..d8ed152d --- /dev/null +++ b/docs/docs/DiskGBAutoScaling.md @@ -0,0 +1,56 @@ +# DiskGBAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling. | [optional] + +## Methods + +### NewDiskGBAutoScaling + +`func NewDiskGBAutoScaling() *DiskGBAutoScaling` + +NewDiskGBAutoScaling instantiates a new DiskGBAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskGBAutoScalingWithDefaults + +`func NewDiskGBAutoScalingWithDefaults() *DiskGBAutoScaling` + +NewDiskGBAutoScalingWithDefaults instantiates a new DiskGBAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *DiskGBAutoScaling) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *DiskGBAutoScaling) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *DiskGBAutoScaling) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *DiskGBAutoScaling) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/DiskPartition.md b/docs/docs/DiskPartition.md new file mode 100644 index 00000000..8d35f655 --- /dev/null +++ b/docs/docs/DiskPartition.md @@ -0,0 +1,82 @@ +# DiskPartition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**PartitionName** | Pointer to **string** | Human-readable label of the disk or partition to which the measurements apply. | [optional] [readonly] + +## Methods + +### NewDiskPartition + +`func NewDiskPartition() *DiskPartition` + +NewDiskPartition instantiates a new DiskPartition object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDiskPartitionWithDefaults + +`func NewDiskPartitionWithDefaults() *DiskPartition` + +NewDiskPartitionWithDefaults instantiates a new DiskPartition object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *DiskPartition) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *DiskPartition) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *DiskPartition) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *DiskPartition) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetPartitionName + +`func (o *DiskPartition) GetPartitionName() string` + +GetPartitionName returns the PartitionName field if non-nil, zero value otherwise. + +### GetPartitionNameOk + +`func (o *DiskPartition) GetPartitionNameOk() (*string, bool)` + +GetPartitionNameOk returns a tuple with the PartitionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartitionName + +`func (o *DiskPartition) SetPartitionName(v string)` + +SetPartitionName sets PartitionName field to given value. + +### HasPartitionName + +`func (o *DiskPartition) HasPartitionName() bool` + +HasPartitionName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EmailNotification.md b/docs/docs/EmailNotification.md new file mode 100644 index 00000000..134ce1b0 --- /dev/null +++ b/docs/docs/EmailNotification.md @@ -0,0 +1,129 @@ +# EmailNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**EmailAddress** | Pointer to **string** | Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don’t need to set this value to send emails to individual or groups of MongoDB Cloud users including: - specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`) - MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`) - MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`) - MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`) To send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewEmailNotification + +`func NewEmailNotification(typeName string, ) *EmailNotification` + +NewEmailNotification instantiates a new EmailNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEmailNotificationWithDefaults + +`func NewEmailNotificationWithDefaults() *EmailNotification` + +NewEmailNotificationWithDefaults instantiates a new EmailNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *EmailNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *EmailNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *EmailNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *EmailNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *EmailNotification) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *EmailNotification) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *EmailNotification) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *EmailNotification) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *EmailNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *EmailNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *EmailNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *EmailNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *EmailNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *EmailNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *EmailNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EncryptionAtRest.md b/docs/docs/EncryptionAtRest.md new file mode 100644 index 00000000..eefdf6f6 --- /dev/null +++ b/docs/docs/EncryptionAtRest.md @@ -0,0 +1,108 @@ +# EncryptionAtRest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsKms** | Pointer to [**AWSKMS**](AWSKMS.md) | | [optional] +**AzureKeyVault** | Pointer to [**AzureKeyVault**](AzureKeyVault.md) | | [optional] +**GoogleCloudKms** | Pointer to [**GoogleCloudKMS**](GoogleCloudKMS.md) | | [optional] + +## Methods + +### NewEncryptionAtRest + +`func NewEncryptionAtRest() *EncryptionAtRest` + +NewEncryptionAtRest instantiates a new EncryptionAtRest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEncryptionAtRestWithDefaults + +`func NewEncryptionAtRestWithDefaults() *EncryptionAtRest` + +NewEncryptionAtRestWithDefaults instantiates a new EncryptionAtRest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAwsKms + +`func (o *EncryptionAtRest) GetAwsKms() AWSKMS` + +GetAwsKms returns the AwsKms field if non-nil, zero value otherwise. + +### GetAwsKmsOk + +`func (o *EncryptionAtRest) GetAwsKmsOk() (*AWSKMS, bool)` + +GetAwsKmsOk returns a tuple with the AwsKms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsKms + +`func (o *EncryptionAtRest) SetAwsKms(v AWSKMS)` + +SetAwsKms sets AwsKms field to given value. + +### HasAwsKms + +`func (o *EncryptionAtRest) HasAwsKms() bool` + +HasAwsKms returns a boolean if a field has been set. + +### GetAzureKeyVault + +`func (o *EncryptionAtRest) GetAzureKeyVault() AzureKeyVault` + +GetAzureKeyVault returns the AzureKeyVault field if non-nil, zero value otherwise. + +### GetAzureKeyVaultOk + +`func (o *EncryptionAtRest) GetAzureKeyVaultOk() (*AzureKeyVault, bool)` + +GetAzureKeyVaultOk returns a tuple with the AzureKeyVault field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureKeyVault + +`func (o *EncryptionAtRest) SetAzureKeyVault(v AzureKeyVault)` + +SetAzureKeyVault sets AzureKeyVault field to given value. + +### HasAzureKeyVault + +`func (o *EncryptionAtRest) HasAzureKeyVault() bool` + +HasAzureKeyVault returns a boolean if a field has been set. + +### GetGoogleCloudKms + +`func (o *EncryptionAtRest) GetGoogleCloudKms() GoogleCloudKMS` + +GetGoogleCloudKms returns the GoogleCloudKms field if non-nil, zero value otherwise. + +### GetGoogleCloudKmsOk + +`func (o *EncryptionAtRest) GetGoogleCloudKmsOk() (*GoogleCloudKMS, bool)` + +GetGoogleCloudKmsOk returns a tuple with the GoogleCloudKms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGoogleCloudKms + +`func (o *EncryptionAtRest) SetGoogleCloudKms(v GoogleCloudKMS)` + +SetGoogleCloudKms sets GoogleCloudKms field to given value. + +### HasGoogleCloudKms + +`func (o *EncryptionAtRest) HasGoogleCloudKms() bool` + +HasGoogleCloudKms returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EncryptionAtRestUsingCustomerKeyManagementApi.md b/docs/docs/EncryptionAtRestUsingCustomerKeyManagementApi.md new file mode 100644 index 00000000..74e7cc81 --- /dev/null +++ b/docs/docs/EncryptionAtRestUsingCustomerKeyManagementApi.md @@ -0,0 +1,160 @@ +# \EncryptionAtRestUsingCustomerKeyManagementApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetEncryptionAtRest**](EncryptionAtRestUsingCustomerKeyManagementApi.md#GetEncryptionAtRest) | **Get** /api/atlas/v2/groups/{groupId}/encryptionAtRest | Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project +[**UpdateEncryptionAtRest**](EncryptionAtRestUsingCustomerKeyManagementApi.md#UpdateEncryptionAtRest) | **Patch** /api/atlas/v2/groups/{groupId}/encryptionAtRest | Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project + + + +## GetEncryptionAtRest + +> EncryptionAtRest GetEncryptionAtRest(ctx, groupId).Execute() + +Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.EncryptionAtRestUsingCustomerKeyManagementApi.GetEncryptionAtRest(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EncryptionAtRestUsingCustomerKeyManagementApi.GetEncryptionAtRest``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetEncryptionAtRest`: EncryptionAtRest + fmt.Fprintf(os.Stdout, "Response from `EncryptionAtRestUsingCustomerKeyManagementApi.GetEncryptionAtRest`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEncryptionAtRestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**EncryptionAtRest**](EncryptionAtRest.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateEncryptionAtRest + +> EncryptionAtRest UpdateEncryptionAtRest(ctx, groupId).EncryptionAtRest(encryptionAtRest).Execute() + +Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + encryptionAtRest := *openapiclient.NewEncryptionAtRest() // EncryptionAtRest | + + resp, r, err := sdk.EncryptionAtRestUsingCustomerKeyManagementApi.UpdateEncryptionAtRest(context.Background(), groupId).EncryptionAtRest(encryptionAtRest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EncryptionAtRestUsingCustomerKeyManagementApi.UpdateEncryptionAtRest``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateEncryptionAtRest`: EncryptionAtRest + fmt.Fprintf(os.Stdout, "Response from `EncryptionAtRestUsingCustomerKeyManagementApi.UpdateEncryptionAtRest`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateEncryptionAtRestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **encryptionAtRest** | [**EncryptionAtRest**](EncryptionAtRest.md) | Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management: If you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider. - To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object. - To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object. - To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object. If you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint. | + +### Return type + +[**EncryptionAtRest**](EncryptionAtRest.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/EncryptionKeyAlertConfigViewForNdsGroup.md b/docs/docs/EncryptionKeyAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..b64cf76b --- /dev/null +++ b/docs/docs/EncryptionKeyAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# EncryptionKeyAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**EncryptionKeyEventTypeViewAlertable**](EncryptionKeyEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**GreaterThanDaysThreshold**](GreaterThanDaysThreshold.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewEncryptionKeyAlertConfigViewForNdsGroup + +`func NewEncryptionKeyAlertConfigViewForNdsGroup(eventTypeName EncryptionKeyEventTypeViewAlertable, ) *EncryptionKeyAlertConfigViewForNdsGroup` + +NewEncryptionKeyAlertConfigViewForNdsGroup instantiates a new EncryptionKeyAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEncryptionKeyAlertConfigViewForNdsGroupWithDefaults + +`func NewEncryptionKeyAlertConfigViewForNdsGroupWithDefaults() *EncryptionKeyAlertConfigViewForNdsGroup` + +NewEncryptionKeyAlertConfigViewForNdsGroupWithDefaults instantiates a new EncryptionKeyAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetEventTypeName() EncryptionKeyEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*EncryptionKeyEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetEventTypeName(v EncryptionKeyEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetThreshold() GreaterThanDaysThreshold` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetThresholdOk() (*GreaterThanDaysThreshold, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetThreshold(v GreaterThanDaysThreshold)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *EncryptionKeyAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EncryptionKeyEventTypeViewAlertable.md b/docs/docs/EncryptionKeyEventTypeViewAlertable.md new file mode 100644 index 00000000..b5eb02b9 --- /dev/null +++ b/docs/docs/EncryptionKeyEventTypeViewAlertable.md @@ -0,0 +1,15 @@ +# EncryptionKeyEventTypeViewAlertable + +## Enum + + +* `AWS_ENCRYPTION_KEY_NEEDS_ROTATION` (value: `"AWS_ENCRYPTION_KEY_NEEDS_ROTATION"`) + +* `AZURE_ENCRYPTION_KEY_NEEDS_ROTATION` (value: `"AZURE_ENCRYPTION_KEY_NEEDS_ROTATION"`) + +* `GCP_ENCRYPTION_KEY_NEEDS_ROTATION` (value: `"GCP_ENCRYPTION_KEY_NEEDS_ROTATION"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Endpoint.md b/docs/docs/Endpoint.md new file mode 100644 index 00000000..0625fbfa --- /dev/null +++ b/docs/docs/Endpoint.md @@ -0,0 +1,290 @@ +# Endpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectionStatus** | Pointer to **string** | State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request. | [optional] [readonly] +**DeleteRequested** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**InterfaceEndpointId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the interface endpoint. | [optional] [readonly] +**PrivateEndpointConnectionName** | Pointer to **string** | Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection. | [optional] [readonly] +**PrivateEndpointIPAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] +**PrivateEndpointResourceId** | Pointer to **string** | Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service. | [optional] [readonly] +**Status** | Pointer to **string** | State of the Google Cloud network endpoint group when MongoDB Cloud received this request. | [optional] [readonly] +**EndpointGroupName** | Pointer to **string** | Human-readable label that identifies a set of endpoints. | [optional] [readonly] +**Endpoints** | Pointer to [**[]GCPConsumerForwardingRule**](GCPConsumerForwardingRule.md) | List of individual private endpoints that comprise this endpoint group. | [optional] [readonly] + +## Methods + +### NewEndpoint + +`func NewEndpoint() *Endpoint` + +NewEndpoint instantiates a new Endpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEndpointWithDefaults + +`func NewEndpointWithDefaults() *Endpoint` + +NewEndpointWithDefaults instantiates a new Endpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetConnectionStatus + +`func (o *Endpoint) GetConnectionStatus() string` + +GetConnectionStatus returns the ConnectionStatus field if non-nil, zero value otherwise. + +### GetConnectionStatusOk + +`func (o *Endpoint) GetConnectionStatusOk() (*string, bool)` + +GetConnectionStatusOk returns a tuple with the ConnectionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionStatus + +`func (o *Endpoint) SetConnectionStatus(v string)` + +SetConnectionStatus sets ConnectionStatus field to given value. + +### HasConnectionStatus + +`func (o *Endpoint) HasConnectionStatus() bool` + +HasConnectionStatus returns a boolean if a field has been set. + +### GetDeleteRequested + +`func (o *Endpoint) GetDeleteRequested() bool` + +GetDeleteRequested returns the DeleteRequested field if non-nil, zero value otherwise. + +### GetDeleteRequestedOk + +`func (o *Endpoint) GetDeleteRequestedOk() (*bool, bool)` + +GetDeleteRequestedOk returns a tuple with the DeleteRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteRequested + +`func (o *Endpoint) SetDeleteRequested(v bool)` + +SetDeleteRequested sets DeleteRequested field to given value. + +### HasDeleteRequested + +`func (o *Endpoint) HasDeleteRequested() bool` + +HasDeleteRequested returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *Endpoint) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *Endpoint) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *Endpoint) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *Endpoint) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetInterfaceEndpointId + +`func (o *Endpoint) GetInterfaceEndpointId() string` + +GetInterfaceEndpointId returns the InterfaceEndpointId field if non-nil, zero value otherwise. + +### GetInterfaceEndpointIdOk + +`func (o *Endpoint) GetInterfaceEndpointIdOk() (*string, bool)` + +GetInterfaceEndpointIdOk returns a tuple with the InterfaceEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterfaceEndpointId + +`func (o *Endpoint) SetInterfaceEndpointId(v string)` + +SetInterfaceEndpointId sets InterfaceEndpointId field to given value. + +### HasInterfaceEndpointId + +`func (o *Endpoint) HasInterfaceEndpointId() bool` + +HasInterfaceEndpointId returns a boolean if a field has been set. + +### GetPrivateEndpointConnectionName + +`func (o *Endpoint) GetPrivateEndpointConnectionName() string` + +GetPrivateEndpointConnectionName returns the PrivateEndpointConnectionName field if non-nil, zero value otherwise. + +### GetPrivateEndpointConnectionNameOk + +`func (o *Endpoint) GetPrivateEndpointConnectionNameOk() (*string, bool)` + +GetPrivateEndpointConnectionNameOk returns a tuple with the PrivateEndpointConnectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointConnectionName + +`func (o *Endpoint) SetPrivateEndpointConnectionName(v string)` + +SetPrivateEndpointConnectionName sets PrivateEndpointConnectionName field to given value. + +### HasPrivateEndpointConnectionName + +`func (o *Endpoint) HasPrivateEndpointConnectionName() bool` + +HasPrivateEndpointConnectionName returns a boolean if a field has been set. + +### GetPrivateEndpointIPAddress + +`func (o *Endpoint) GetPrivateEndpointIPAddress() string` + +GetPrivateEndpointIPAddress returns the PrivateEndpointIPAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIPAddressOk + +`func (o *Endpoint) GetPrivateEndpointIPAddressOk() (*string, bool)` + +GetPrivateEndpointIPAddressOk returns a tuple with the PrivateEndpointIPAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIPAddress + +`func (o *Endpoint) SetPrivateEndpointIPAddress(v string)` + +SetPrivateEndpointIPAddress sets PrivateEndpointIPAddress field to given value. + +### HasPrivateEndpointIPAddress + +`func (o *Endpoint) HasPrivateEndpointIPAddress() bool` + +HasPrivateEndpointIPAddress returns a boolean if a field has been set. + +### GetPrivateEndpointResourceId + +`func (o *Endpoint) GetPrivateEndpointResourceId() string` + +GetPrivateEndpointResourceId returns the PrivateEndpointResourceId field if non-nil, zero value otherwise. + +### GetPrivateEndpointResourceIdOk + +`func (o *Endpoint) GetPrivateEndpointResourceIdOk() (*string, bool)` + +GetPrivateEndpointResourceIdOk returns a tuple with the PrivateEndpointResourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointResourceId + +`func (o *Endpoint) SetPrivateEndpointResourceId(v string)` + +SetPrivateEndpointResourceId sets PrivateEndpointResourceId field to given value. + +### HasPrivateEndpointResourceId + +`func (o *Endpoint) HasPrivateEndpointResourceId() bool` + +HasPrivateEndpointResourceId returns a boolean if a field has been set. + +### GetStatus + +`func (o *Endpoint) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Endpoint) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Endpoint) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Endpoint) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetEndpointGroupName + +`func (o *Endpoint) GetEndpointGroupName() string` + +GetEndpointGroupName returns the EndpointGroupName field if non-nil, zero value otherwise. + +### GetEndpointGroupNameOk + +`func (o *Endpoint) GetEndpointGroupNameOk() (*string, bool)` + +GetEndpointGroupNameOk returns a tuple with the EndpointGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointGroupName + +`func (o *Endpoint) SetEndpointGroupName(v string)` + +SetEndpointGroupName sets EndpointGroupName field to given value. + +### HasEndpointGroupName + +`func (o *Endpoint) HasEndpointGroupName() bool` + +HasEndpointGroupName returns a boolean if a field has been set. + +### GetEndpoints + +`func (o *Endpoint) GetEndpoints() []GCPConsumerForwardingRule` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *Endpoint) GetEndpointsOk() (*[]GCPConsumerForwardingRule, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpoints + +`func (o *Endpoint) SetEndpoints(v []GCPConsumerForwardingRule)` + +SetEndpoints sets Endpoints field to given value. + +### HasEndpoints + +`func (o *Endpoint) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EndpointService.md b/docs/docs/EndpointService.md new file mode 100644 index 00000000..162aa482 --- /dev/null +++ b/docs/docs/EndpointService.md @@ -0,0 +1,316 @@ +# EndpointService + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointServiceName** | Pointer to **string** | Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. | [optional] [readonly] +**InterfaceEndpoints** | Pointer to **[]string** | List of strings that identify private endpoint interfaces applied to the specified project. | [optional] [readonly] +**RegionName** | Pointer to **string** | Cloud provider region that manages this Private Endpoint Service. | [optional] [readonly] +**Status** | Pointer to **string** | State of the Private Endpoint Service connection when MongoDB Cloud received this request. | [optional] [readonly] +**PrivateEndpoints** | Pointer to **[]string** | List of private endpoints assigned to this Azure Private Link Service. | [optional] [readonly] +**PrivateLinkServiceName** | Pointer to **string** | Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages. | [optional] [readonly] +**PrivateLinkServiceResourceId** | Pointer to **string** | Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet. | [optional] [readonly] +**EndpointGroupNames** | Pointer to **[]string** | List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service. | [optional] +**ServiceAttachmentNames** | Pointer to **[]string** | List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network. | [optional] + +## Methods + +### NewEndpointService + +`func NewEndpointService() *EndpointService` + +NewEndpointService instantiates a new EndpointService object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEndpointServiceWithDefaults + +`func NewEndpointServiceWithDefaults() *EndpointService` + +NewEndpointServiceWithDefaults instantiates a new EndpointService object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointServiceName + +`func (o *EndpointService) GetEndpointServiceName() string` + +GetEndpointServiceName returns the EndpointServiceName field if non-nil, zero value otherwise. + +### GetEndpointServiceNameOk + +`func (o *EndpointService) GetEndpointServiceNameOk() (*string, bool)` + +GetEndpointServiceNameOk returns a tuple with the EndpointServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointServiceName + +`func (o *EndpointService) SetEndpointServiceName(v string)` + +SetEndpointServiceName sets EndpointServiceName field to given value. + +### HasEndpointServiceName + +`func (o *EndpointService) HasEndpointServiceName() bool` + +HasEndpointServiceName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *EndpointService) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *EndpointService) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *EndpointService) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *EndpointService) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetId + +`func (o *EndpointService) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EndpointService) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EndpointService) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EndpointService) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetInterfaceEndpoints + +`func (o *EndpointService) GetInterfaceEndpoints() []string` + +GetInterfaceEndpoints returns the InterfaceEndpoints field if non-nil, zero value otherwise. + +### GetInterfaceEndpointsOk + +`func (o *EndpointService) GetInterfaceEndpointsOk() (*[]string, bool)` + +GetInterfaceEndpointsOk returns a tuple with the InterfaceEndpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterfaceEndpoints + +`func (o *EndpointService) SetInterfaceEndpoints(v []string)` + +SetInterfaceEndpoints sets InterfaceEndpoints field to given value. + +### HasInterfaceEndpoints + +`func (o *EndpointService) HasInterfaceEndpoints() bool` + +HasInterfaceEndpoints returns a boolean if a field has been set. + +### GetRegionName + +`func (o *EndpointService) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *EndpointService) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *EndpointService) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *EndpointService) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetStatus + +`func (o *EndpointService) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *EndpointService) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *EndpointService) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *EndpointService) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetPrivateEndpoints + +`func (o *EndpointService) GetPrivateEndpoints() []string` + +GetPrivateEndpoints returns the PrivateEndpoints field if non-nil, zero value otherwise. + +### GetPrivateEndpointsOk + +`func (o *EndpointService) GetPrivateEndpointsOk() (*[]string, bool)` + +GetPrivateEndpointsOk returns a tuple with the PrivateEndpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpoints + +`func (o *EndpointService) SetPrivateEndpoints(v []string)` + +SetPrivateEndpoints sets PrivateEndpoints field to given value. + +### HasPrivateEndpoints + +`func (o *EndpointService) HasPrivateEndpoints() bool` + +HasPrivateEndpoints returns a boolean if a field has been set. + +### GetPrivateLinkServiceName + +`func (o *EndpointService) GetPrivateLinkServiceName() string` + +GetPrivateLinkServiceName returns the PrivateLinkServiceName field if non-nil, zero value otherwise. + +### GetPrivateLinkServiceNameOk + +`func (o *EndpointService) GetPrivateLinkServiceNameOk() (*string, bool)` + +GetPrivateLinkServiceNameOk returns a tuple with the PrivateLinkServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateLinkServiceName + +`func (o *EndpointService) SetPrivateLinkServiceName(v string)` + +SetPrivateLinkServiceName sets PrivateLinkServiceName field to given value. + +### HasPrivateLinkServiceName + +`func (o *EndpointService) HasPrivateLinkServiceName() bool` + +HasPrivateLinkServiceName returns a boolean if a field has been set. + +### GetPrivateLinkServiceResourceId + +`func (o *EndpointService) GetPrivateLinkServiceResourceId() string` + +GetPrivateLinkServiceResourceId returns the PrivateLinkServiceResourceId field if non-nil, zero value otherwise. + +### GetPrivateLinkServiceResourceIdOk + +`func (o *EndpointService) GetPrivateLinkServiceResourceIdOk() (*string, bool)` + +GetPrivateLinkServiceResourceIdOk returns a tuple with the PrivateLinkServiceResourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateLinkServiceResourceId + +`func (o *EndpointService) SetPrivateLinkServiceResourceId(v string)` + +SetPrivateLinkServiceResourceId sets PrivateLinkServiceResourceId field to given value. + +### HasPrivateLinkServiceResourceId + +`func (o *EndpointService) HasPrivateLinkServiceResourceId() bool` + +HasPrivateLinkServiceResourceId returns a boolean if a field has been set. + +### GetEndpointGroupNames + +`func (o *EndpointService) GetEndpointGroupNames() []string` + +GetEndpointGroupNames returns the EndpointGroupNames field if non-nil, zero value otherwise. + +### GetEndpointGroupNamesOk + +`func (o *EndpointService) GetEndpointGroupNamesOk() (*[]string, bool)` + +GetEndpointGroupNamesOk returns a tuple with the EndpointGroupNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointGroupNames + +`func (o *EndpointService) SetEndpointGroupNames(v []string)` + +SetEndpointGroupNames sets EndpointGroupNames field to given value. + +### HasEndpointGroupNames + +`func (o *EndpointService) HasEndpointGroupNames() bool` + +HasEndpointGroupNames returns a boolean if a field has been set. + +### GetServiceAttachmentNames + +`func (o *EndpointService) GetServiceAttachmentNames() []string` + +GetServiceAttachmentNames returns the ServiceAttachmentNames field if non-nil, zero value otherwise. + +### GetServiceAttachmentNamesOk + +`func (o *EndpointService) GetServiceAttachmentNamesOk() (*[]string, bool)` + +GetServiceAttachmentNamesOk returns a tuple with the ServiceAttachmentNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceAttachmentNames + +`func (o *EndpointService) SetServiceAttachmentNames(v []string)` + +SetServiceAttachmentNames sets ServiceAttachmentNames field to given value. + +### HasServiceAttachmentNames + +`func (o *EndpointService) HasServiceAttachmentNames() bool` + +HasServiceAttachmentNames returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Error.md b/docs/docs/Error.md new file mode 100644 index 00000000..62744f39 --- /dev/null +++ b/docs/docs/Error.md @@ -0,0 +1,160 @@ +# Error + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Detail** | Pointer to **string** | | [optional] +**Error** | Pointer to **int** | HTTP status code returned with this error. | [optional] +**ErrorCode** | Pointer to **string** | Application error code returned with this error. | [optional] +**Parameters** | Pointer to **[]interface{}** | Parameter uses to give more information about the error. | [optional] +**Reason** | Pointer to **string** | Application error message returned with this error. | [optional] + +## Methods + +### NewError + +`func NewError() *Error` + +NewError instantiates a new Error object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewErrorWithDefaults + +`func NewErrorWithDefaults() *Error` + +NewErrorWithDefaults instantiates a new Error object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDetail + +`func (o *Error) GetDetail() string` + +GetDetail returns the Detail field if non-nil, zero value otherwise. + +### GetDetailOk + +`func (o *Error) GetDetailOk() (*string, bool)` + +GetDetailOk returns a tuple with the Detail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetail + +`func (o *Error) SetDetail(v string)` + +SetDetail sets Detail field to given value. + +### HasDetail + +`func (o *Error) HasDetail() bool` + +HasDetail returns a boolean if a field has been set. + +### GetError + +`func (o *Error) GetError() int` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *Error) GetErrorOk() (*int, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *Error) SetError(v int)` + +SetError sets Error field to given value. + +### HasError + +`func (o *Error) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *Error) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *Error) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *Error) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *Error) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetParameters + +`func (o *Error) GetParameters() []interface{}` + +GetParameters returns the Parameters field if non-nil, zero value otherwise. + +### GetParametersOk + +`func (o *Error) GetParametersOk() (*[]interface{}, bool)` + +GetParametersOk returns a tuple with the Parameters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParameters + +`func (o *Error) SetParameters(v []interface{})` + +SetParameters sets Parameters field to given value. + +### HasParameters + +`func (o *Error) HasParameters() bool` + +HasParameters returns a boolean if a field has been set. + +### GetReason + +`func (o *Error) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *Error) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *Error) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *Error) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EventTypeForNdsGroup.md b/docs/docs/EventTypeForNdsGroup.md new file mode 100644 index 00000000..90b7b685 --- /dev/null +++ b/docs/docs/EventTypeForNdsGroup.md @@ -0,0 +1,923 @@ +# EventTypeForNdsGroup + +## Enum + + +* `ALERT_ACKNOWLEDGED_AUDIT` (value: `"ALERT_ACKNOWLEDGED_AUDIT"`) + +* `ALERT_UNACKNOWLEDGED_AUDIT` (value: `"ALERT_UNACKNOWLEDGED_AUDIT"`) + +* `ALERT_CONFIG_DISABLED_AUDIT` (value: `"ALERT_CONFIG_DISABLED_AUDIT"`) + +* `ALERT_CONFIG_ENABLED_AUDIT` (value: `"ALERT_CONFIG_ENABLED_AUDIT"`) + +* `ALERT_CONFIG_ADDED_AUDIT` (value: `"ALERT_CONFIG_ADDED_AUDIT"`) + +* `ALERT_CONFIG_DELETED_AUDIT` (value: `"ALERT_CONFIG_DELETED_AUDIT"`) + +* `ALERT_CONFIG_CHANGED_AUDIT` (value: `"ALERT_CONFIG_CHANGED_AUDIT"`) + +* `API_KEY_CREATED` (value: `"API_KEY_CREATED"`) + +* `API_KEY_DELETED` (value: `"API_KEY_DELETED"`) + +* `API_KEY_ACCESS_LIST_ENTRY_ADDED` (value: `"API_KEY_ACCESS_LIST_ENTRY_ADDED"`) + +* `API_KEY_ACCESS_LIST_ENTRY_DELETED` (value: `"API_KEY_ACCESS_LIST_ENTRY_DELETED"`) + +* `API_KEY_ROLES_CHANGED` (value: `"API_KEY_ROLES_CHANGED"`) + +* `API_KEY_DESCRIPTION_CHANGED` (value: `"API_KEY_DESCRIPTION_CHANGED"`) + +* `API_KEY_ADDED_TO_GROUP` (value: `"API_KEY_ADDED_TO_GROUP"`) + +* `API_KEY_REMOVED_FROM_GROUP` (value: `"API_KEY_REMOVED_FROM_GROUP"`) + +* `API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED"`) + +* `API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED"`) + +* `URL_CONFIRMATION` (value: `"URL_CONFIRMATION"`) + +* `SUCCESSFUL_DEPLOY` (value: `"SUCCESSFUL_DEPLOY"`) + +* `DEPLOYMENT_FAILURE` (value: `"DEPLOYMENT_FAILURE"`) + +* `DEPLOYMENT_MODEL_CHANGE_SUCCESS` (value: `"DEPLOYMENT_MODEL_CHANGE_SUCCESS"`) + +* `DEPLOYMENT_MODEL_CHANGE_FAILURE` (value: `"DEPLOYMENT_MODEL_CHANGE_FAILURE"`) + +* `REQUEST_RATE_LIMIT` (value: `"REQUEST_RATE_LIMIT"`) + +* `LOG_FORWARDER_FAILURE` (value: `"LOG_FORWARDER_FAILURE"`) + +* `INSIDE_REALM_METRIC_THRESHOLD` (value: `"INSIDE_REALM_METRIC_THRESHOLD"`) + +* `OUTSIDE_REALM_METRIC_THRESHOLD` (value: `"OUTSIDE_REALM_METRIC_THRESHOLD"`) + +* `SYNC_FAILURE` (value: `"SYNC_FAILURE"`) + +* `TRIGGER_FAILURE` (value: `"TRIGGER_FAILURE"`) + +* `TRIGGER_AUTO_RESUMED` (value: `"TRIGGER_AUTO_RESUMED"`) + +* `AUTO_INDEXING_ENABLED` (value: `"AUTO_INDEXING_ENABLED"`) + +* `AUTO_INDEXING_DISABLED` (value: `"AUTO_INDEXING_DISABLED"`) + +* `AUTO_INDEXING_INDEX_BUILD_SUBMITTED` (value: `"AUTO_INDEXING_INDEX_BUILD_SUBMITTED"`) + +* `AUTO_INDEXING_SLOW_INDEX_BUILD` (value: `"AUTO_INDEXING_SLOW_INDEX_BUILD"`) + +* `AUTO_INDEXING_STALLED_INDEX_BUILD` (value: `"AUTO_INDEXING_STALLED_INDEX_BUILD"`) + +* `AUTO_INDEXING_FAILED_INDEX_BUILD` (value: `"AUTO_INDEXING_FAILED_INDEX_BUILD"`) + +* `AUTO_INDEXING_COMPLETED_INDEX_BUILD` (value: `"AUTO_INDEXING_COMPLETED_INDEX_BUILD"`) + +* `AUTOMATION_CONFIG_PUBLISHED_AUDIT` (value: `"AUTOMATION_CONFIG_PUBLISHED_AUDIT"`) + +* `PEER_CREATED` (value: `"PEER_CREATED"`) + +* `PEER_DELETED` (value: `"PEER_DELETED"`) + +* `PEER_UPDATED` (value: `"PEER_UPDATED"`) + +* `AZURE_PEER_CREATED` (value: `"AZURE_PEER_CREATED"`) + +* `AZURE_PEER_UPDATED` (value: `"AZURE_PEER_UPDATED"`) + +* `AZURE_PEER_ACTIVE` (value: `"AZURE_PEER_ACTIVE"`) + +* `AZURE_PEER_DELETED` (value: `"AZURE_PEER_DELETED"`) + +* `CREDIT_CARD_CURRENT` (value: `"CREDIT_CARD_CURRENT"`) + +* `CREDIT_CARD_ABOUT_TO_EXPIRE` (value: `"CREDIT_CARD_ABOUT_TO_EXPIRE"`) + +* `PENDING_INVOICE_UNDER_THRESHOLD` (value: `"PENDING_INVOICE_UNDER_THRESHOLD"`) + +* `PENDING_INVOICE_OVER_THRESHOLD` (value: `"PENDING_INVOICE_OVER_THRESHOLD"`) + +* `DAILY_BILL_UNDER_THRESHOLD` (value: `"DAILY_BILL_UNDER_THRESHOLD"`) + +* `DAILY_BILL_OVER_THRESHOLD` (value: `"DAILY_BILL_OVER_THRESHOLD"`) + +* `CHARGE_SUCCEEDED` (value: `"CHARGE_SUCCEEDED"`) + +* `CHARGE_FAILED` (value: `"CHARGE_FAILED"`) + +* `CHARGE_PROCESSING` (value: `"CHARGE_PROCESSING"`) + +* `CHARGE_PENDING_REVERSAL` (value: `"CHARGE_PENDING_REVERSAL"`) + +* `BRAINTREE_CHARGE_FAILED` (value: `"BRAINTREE_CHARGE_FAILED"`) + +* `INVOICE_CLOSED` (value: `"INVOICE_CLOSED"`) + +* `CHECK_PAYMENT_RECEIVED` (value: `"CHECK_PAYMENT_RECEIVED"`) + +* `WIRE_TRANSFER_PAYMENT_RECEIVED` (value: `"WIRE_TRANSFER_PAYMENT_RECEIVED"`) + +* `DISCOUNT_APPLIED` (value: `"DISCOUNT_APPLIED"`) + +* `CREDIT_ISSUED` (value: `"CREDIT_ISSUED"`) + +* `CREDIT_PULLED_FWD` (value: `"CREDIT_PULLED_FWD"`) + +* `CREDIT_START_DATE_MODIFIED` (value: `"CREDIT_START_DATE_MODIFIED"`) + +* `CREDIT_END_DATE_MODIFIED` (value: `"CREDIT_END_DATE_MODIFIED"`) + +* `CREDIT_ELASTIC_INVOICING_MODIFIED` (value: `"CREDIT_ELASTIC_INVOICING_MODIFIED"`) + +* `CREDIT_TYPE_MODIFIED` (value: `"CREDIT_TYPE_MODIFIED"`) + +* `CREDIT_AMOUNT_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_CENTS_MODIFIED"`) + +* `CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED"`) + +* `CREDIT_TOTAL_BILLED_CENTS_MODIFIED` (value: `"CREDIT_TOTAL_BILLED_CENTS_MODIFIED"`) + +* `CREDIT_AWS_CUSTOMER_ID_MODIFIED` (value: `"CREDIT_AWS_CUSTOMER_ID_MODIFIED"`) + +* `CREDIT_AWS_PRODUCT_CODE_MODIFIED` (value: `"CREDIT_AWS_PRODUCT_CODE_MODIFIED"`) + +* `CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED` (value: `"CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED"`) + +* `CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED` (value: `"CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED"`) + +* `PROMO_CODE_APPLIED` (value: `"PROMO_CODE_APPLIED"`) + +* `PAYMENT_FORGIVEN` (value: `"PAYMENT_FORGIVEN"`) + +* `REFUND_ISSUED` (value: `"REFUND_ISSUED"`) + +* `ACCOUNT_DOWNGRADED` (value: `"ACCOUNT_DOWNGRADED"`) + +* `ACCOUNT_UPGRADED` (value: `"ACCOUNT_UPGRADED"`) + +* `ACCOUNT_MODIFIED` (value: `"ACCOUNT_MODIFIED"`) + +* `SUPPORT_PLAN_ACTIVATED` (value: `"SUPPORT_PLAN_ACTIVATED"`) + +* `SUPPORT_PLAN_CANCELLED` (value: `"SUPPORT_PLAN_CANCELLED"`) + +* `SUPPORT_PLAN_CANCELLATION_SCHEDULED` (value: `"SUPPORT_PLAN_CANCELLATION_SCHEDULED"`) + +* `INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC` (value: `"INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC"`) + +* `INVOICE_ADDRESS_CHANGED` (value: `"INVOICE_ADDRESS_CHANGED"`) + +* `INVOICE_ADDRESS_ADDED` (value: `"INVOICE_ADDRESS_ADDED"`) + +* `PREPAID_PLAN_ACTIVATED` (value: `"PREPAID_PLAN_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_ACTIVATED` (value: `"ELASTIC_INVOICING_MODE_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_DEACTIVATED` (value: `"ELASTIC_INVOICING_MODE_DEACTIVATED"`) + +* `TERMINATE_PAID_SERVICES` (value: `"TERMINATE_PAID_SERVICES"`) + +* `BILLING_EMAIL_ADDRESS_ADDED` (value: `"BILLING_EMAIL_ADDRESS_ADDED"`) + +* `BILLING_EMAIL_ADDRESS_CHANGED` (value: `"BILLING_EMAIL_ADDRESS_CHANGED"`) + +* `BILLING_EMAIL_ADDRESS_REMOVED` (value: `"BILLING_EMAIL_ADDRESS_REMOVED"`) + +* `CLUSTER_CONNECTION_GET_DATABASES` (value: `"CLUSTER_CONNECTION_GET_DATABASES"`) + +* `CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS` (value: `"CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS"`) + +* `CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES` (value: `"CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES"`) + +* `CLUSTER_CONNECTION_AGGREGATE` (value: `"CLUSTER_CONNECTION_AGGREGATE"`) + +* `CLUSTER_CONNECTION_CREATE_COLLECTION` (value: `"CLUSTER_CONNECTION_CREATE_COLLECTION"`) + +* `CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES` (value: `"CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES"`) + +* `CLUSTER_MONGOS_IS_PRESENT` (value: `"CLUSTER_MONGOS_IS_PRESENT"`) + +* `CLUSTER_MONGOS_IS_MISSING` (value: `"CLUSTER_MONGOS_IS_MISSING"`) + +* `CPS_SNAPSHOT_SUCCESSFUL` (value: `"CPS_SNAPSHOT_SUCCESSFUL"`) + +* `CPS_SNAPSHOT_FALLBACK_SUCCESSFUL` (value: `"CPS_SNAPSHOT_FALLBACK_SUCCESSFUL"`) + +* `CPS_SNAPSHOT_BEHIND` (value: `"CPS_SNAPSHOT_BEHIND"`) + +* `CPS_SNAPSHOT_FALLBACK_FAILED` (value: `"CPS_SNAPSHOT_FALLBACK_FAILED"`) + +* `CPS_RESTORE_SUCCESSFUL` (value: `"CPS_RESTORE_SUCCESSFUL"`) + +* `CPS_EXPORT_SUCCESSFUL` (value: `"CPS_EXPORT_SUCCESSFUL"`) + +* `CPS_RESTORE_FAILED` (value: `"CPS_RESTORE_FAILED"`) + +* `CPS_EXPORT_FAILED` (value: `"CPS_EXPORT_FAILED"`) + +* `CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED` (value: `"CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED"`) + +* `DATA_EXPLORER` (value: `"DATA_EXPLORER"`) + +* `DATA_EXPLORER_CRUD_ATTEMPT` (value: `"DATA_EXPLORER_CRUD_ATTEMPT"`) + +* `DATA_EXPLORER_CRUD_ERROR` (value: `"DATA_EXPLORER_CRUD_ERROR"`) + +* `DATA_EXPLORER_CRUD` (value: `"DATA_EXPLORER_CRUD"`) + +* `CPS_DATA_PROTECTION_ENABLE_REQUESTED` (value: `"CPS_DATA_PROTECTION_ENABLE_REQUESTED"`) + +* `CPS_DATA_PROTECTION_ENABLED` (value: `"CPS_DATA_PROTECTION_ENABLED"`) + +* `CPS_DATA_PROTECTION_UPDATE_REQUESTED` (value: `"CPS_DATA_PROTECTION_UPDATE_REQUESTED"`) + +* `CPS_DATA_PROTECTION_UPDATED` (value: `"CPS_DATA_PROTECTION_UPDATED"`) + +* `CPS_DATA_PROTECTION_DISABLE_REQUESTED` (value: `"CPS_DATA_PROTECTION_DISABLE_REQUESTED"`) + +* `CPS_DATA_PROTECTION_DISABLED` (value: `"CPS_DATA_PROTECTION_DISABLED"`) + +* `CPS_RESTORE_REQUESTED_AUDIT` (value: `"CPS_RESTORE_REQUESTED_AUDIT"`) + +* `CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` (value: `"CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT"`) + +* `CPS_SNAPSHOT_DELETED_AUDIT` (value: `"CPS_SNAPSHOT_DELETED_AUDIT"`) + +* `CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT` (value: `"CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT"`) + +* `CPS_SNAPSHOT_IN_PROGRESS_AUDIT` (value: `"CPS_SNAPSHOT_IN_PROGRESS_AUDIT"`) + +* `CPS_SNAPSHOT_COMPLETED_AUDIT` (value: `"CPS_SNAPSHOT_COMPLETED_AUDIT"`) + +* `CPS_ON_DEMAND_SNAPSHOT_REQUESTED` (value: `"CPS_ON_DEMAND_SNAPSHOT_REQUESTED"`) + +* `AWS_ENCRYPTION_KEY_ROTATED` (value: `"AWS_ENCRYPTION_KEY_ROTATED"`) + +* `AWS_ENCRYPTION_KEY_NEEDS_ROTATION` (value: `"AWS_ENCRYPTION_KEY_NEEDS_ROTATION"`) + +* `AZURE_ENCRYPTION_KEY_ROTATED` (value: `"AZURE_ENCRYPTION_KEY_ROTATED"`) + +* `AZURE_ENCRYPTION_KEY_NEEDS_ROTATION` (value: `"AZURE_ENCRYPTION_KEY_NEEDS_ROTATION"`) + +* `GCP_ENCRYPTION_KEY_ROTATED` (value: `"GCP_ENCRYPTION_KEY_ROTATED"`) + +* `GCP_ENCRYPTION_KEY_NEEDS_ROTATION` (value: `"GCP_ENCRYPTION_KEY_NEEDS_ROTATION"`) + +* `BUCKET_CREATED_AUDIT` (value: `"BUCKET_CREATED_AUDIT"`) + +* `BUCKET_DELETED_AUDIT` (value: `"BUCKET_DELETED_AUDIT"`) + +* `FTS_INDEX_DELETION_FAILED` (value: `"FTS_INDEX_DELETION_FAILED"`) + +* `FTS_INDEX_BUILD_COMPLETE` (value: `"FTS_INDEX_BUILD_COMPLETE"`) + +* `FTS_INDEX_BUILD_FAILED` (value: `"FTS_INDEX_BUILD_FAILED"`) + +* `FTS_INDEX_CREATED` (value: `"FTS_INDEX_CREATED"`) + +* `FTS_INDEX_UPDATED` (value: `"FTS_INDEX_UPDATED"`) + +* `FTS_INDEX_DELETED` (value: `"FTS_INDEX_DELETED"`) + +* `GCP_PEER_CREATED` (value: `"GCP_PEER_CREATED"`) + +* `GCP_PEER_DELETED` (value: `"GCP_PEER_DELETED"`) + +* `GCP_PEER_UPDATED` (value: `"GCP_PEER_UPDATED"`) + +* `GCP_PEER_ACTIVE` (value: `"GCP_PEER_ACTIVE"`) + +* `GCP_PEER_INACTIVE` (value: `"GCP_PEER_INACTIVE"`) + +* `DATA_EXPLORER_ENABLED` (value: `"DATA_EXPLORER_ENABLED"`) + +* `DATA_EXPLORER_DISABLED` (value: `"DATA_EXPLORER_DISABLED"`) + +* `CREDIT_CARD_ADDED` (value: `"CREDIT_CARD_ADDED"`) + +* `CREDIT_CARD_UPDATED` (value: `"CREDIT_CARD_UPDATED"`) + +* `GROUP_DELETED` (value: `"GROUP_DELETED"`) + +* `GROUP_CREATED` (value: `"GROUP_CREATED"`) + +* `GROUP_MOVED` (value: `"GROUP_MOVED"`) + +* `GROUP_TEMPORARILY_ACTIVATED` (value: `"GROUP_TEMPORARILY_ACTIVATED"`) + +* `TEMPORARILY_ACTIVATED` (value: `"TEMPORARILY_ACTIVATED"`) + +* `GROUP_ACTIVATED` (value: `"GROUP_ACTIVATED"`) + +* `ACTIVATED` (value: `"ACTIVATED"`) + +* `GROUP_LOCKED` (value: `"GROUP_LOCKED"`) + +* `LOCKED` (value: `"LOCKED"`) + +* `GROUP_SUSPENDED` (value: `"GROUP_SUSPENDED"`) + +* `SUSPENDED` (value: `"SUSPENDED"`) + +* `GROUP_FLUSHED` (value: `"GROUP_FLUSHED"`) + +* `FLUSHED` (value: `"FLUSHED"`) + +* `GROUP_NAME_CHANGED` (value: `"GROUP_NAME_CHANGED"`) + +* `GROUP_CHARTS_ACTIVATION_REQUESTED` (value: `"GROUP_CHARTS_ACTIVATION_REQUESTED"`) + +* `CHARTS_ACTIVATION_REQUESTED` (value: `"CHARTS_ACTIVATION_REQUESTED"`) + +* `GROUP_CHARTS_ACTIVATED` (value: `"GROUP_CHARTS_ACTIVATED"`) + +* `CHARTS_ACTIVATED` (value: `"CHARTS_ACTIVATED"`) + +* `GROUP_CHARTS_UPGRADED` (value: `"GROUP_CHARTS_UPGRADED"`) + +* `CHARTS_UPGRADED` (value: `"CHARTS_UPGRADED"`) + +* `GROUP_CHARTS_RESET` (value: `"GROUP_CHARTS_RESET"`) + +* `CHARTS_RESET` (value: `"CHARTS_RESET"`) + +* `PAID_IN_FULL` (value: `"PAID_IN_FULL"`) + +* `DELINQUENT` (value: `"DELINQUENT"`) + +* `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` (value: `"ALL_USERS_HAVE_MULTI_FACTOR_AUTH"`) + +* `ALL_USERS_HAVE_MULTIFACTOR_AUTH` (value: `"ALL_USERS_HAVE_MULTIFACTOR_AUTH"`) + +* `USERS_WITHOUT_MULTI_FACTOR_AUTH` (value: `"USERS_WITHOUT_MULTI_FACTOR_AUTH"`) + +* `USERS_WITHOUT_MULTIFACTOR_AUTH` (value: `"USERS_WITHOUT_MULTIFACTOR_AUTH"`) + +* `M0_CLUSTERS_PER_GROUP_WITHIN_LIMIT` (value: `"M0_CLUSTERS_PER_GROUP_WITHIN_LIMIT"`) + +* `MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED` (value: `"MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED"`) + +* `INTEGRATION_CONFIGURED` (value: `"INTEGRATION_CONFIGURED"`) + +* `INTEGRATION_REMOVED` (value: `"INTEGRATION_REMOVED"`) + +* `AUTO_CREATED_INDEX_AUDIT` (value: `"AUTO_CREATED_INDEX_AUDIT"`) + +* `ATTEMPT_KILLOP_AUDIT` (value: `"ATTEMPT_KILLOP_AUDIT"`) + +* `ATTEMPT_KILLSESSION_AUDIT` (value: `"ATTEMPT_KILLSESSION_AUDIT"`) + +* `HOST_UP` (value: `"HOST_UP"`) + +* `HOST_DOWN` (value: `"HOST_DOWN"`) + +* `HOST_HAS_INDEX_SUGGESTIONS` (value: `"HOST_HAS_INDEX_SUGGESTIONS"`) + +* `HOST_MONGOT_RECOVERED_OOM` (value: `"HOST_MONGOT_RECOVERED_OOM"`) + +* `HOST_MONGOT_CRASHING_OOM` (value: `"HOST_MONGOT_CRASHING_OOM"`) + +* `HOST_DISK_SPACE_SUFFICIENT_FOR_SEARCH_INDEX_REBUILD` (value: `"HOST_DISK_SPACE_SUFFICIENT_FOR_SEARCH_INDEX_REBUILD"`) + +* `HOST_ENOUGH_DISK_SPACE` (value: `"HOST_ENOUGH_DISK_SPACE"`) + +* `HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD` (value: `"HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD"`) + +* `HOST_NOT_ENOUGH_DISK_SPACE` (value: `"HOST_NOT_ENOUGH_DISK_SPACE"`) + +* `INSIDE_METRIC_THRESHOLD` (value: `"INSIDE_METRIC_THRESHOLD"`) + +* `OUTSIDE_METRIC_THRESHOLD` (value: `"OUTSIDE_METRIC_THRESHOLD"`) + +* `ROLLING_INDEX_FAILED_INDEX_BUILD` (value: `"ROLLING_INDEX_FAILED_INDEX_BUILD"`) + +* `ROLLING_INDEX_SUCCESS_INDEX_BUILD` (value: `"ROLLING_INDEX_SUCCESS_INDEX_BUILD"`) + +* `INDEX_FAILED_INDEX_BUILD` (value: `"INDEX_FAILED_INDEX_BUILD"`) + +* `INDEX_SUCCESS_INDEX_BUILD` (value: `"INDEX_SUCCESS_INDEX_BUILD"`) + +* `CLUSTER_CREATED` (value: `"CLUSTER_CREATED"`) + +* `CLUSTER_READY` (value: `"CLUSTER_READY"`) + +* `CLUSTER_UPDATE_SUBMITTED` (value: `"CLUSTER_UPDATE_SUBMITTED"`) + +* `CLUSTER_UPDATE_SUBMITTED_INTERNAL` (value: `"CLUSTER_UPDATE_SUBMITTED_INTERNAL"`) + +* `CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED` (value: `"CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED"`) + +* `CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED` (value: `"CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED"`) + +* `CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED` (value: `"CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED"`) + +* `CLUSTER_AUTOMATICALLY_PAUSED` (value: `"CLUSTER_AUTOMATICALLY_PAUSED"`) + +* `CLUSTER_UPDATE_STARTED` (value: `"CLUSTER_UPDATE_STARTED"`) + +* `CLUSTER_UPDATE_COMPLETED` (value: `"CLUSTER_UPDATE_COMPLETED"`) + +* `CLUSTER_DELETE_SUBMITTED` (value: `"CLUSTER_DELETE_SUBMITTED"`) + +* `CLUSTER_DELETE_SUBMITTED_INTERNAL` (value: `"CLUSTER_DELETE_SUBMITTED_INTERNAL"`) + +* `CLUSTER_DELETED` (value: `"CLUSTER_DELETED"`) + +* `CLUSTER_IMPORT_STARTED` (value: `"CLUSTER_IMPORT_STARTED"`) + +* `CLUSTER_IMPORT_CANCELLED` (value: `"CLUSTER_IMPORT_CANCELLED"`) + +* `CLUSTER_IMPORT_EXPIRED` (value: `"CLUSTER_IMPORT_EXPIRED"`) + +* `CLUSTER_IMPORT_CUTOVER` (value: `"CLUSTER_IMPORT_CUTOVER"`) + +* `CLUSTER_IMPORT_RESTART_REQUESTED` (value: `"CLUSTER_IMPORT_RESTART_REQUESTED"`) + +* `PROJECT_LIVE_IMPORT_OVERRIDES_ADDED` (value: `"PROJECT_LIVE_IMPORT_OVERRIDES_ADDED"`) + +* `PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED` (value: `"PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED"`) + +* `PROJECT_LIVE_IMPORT_OVERRIDES_DELETED` (value: `"PROJECT_LIVE_IMPORT_OVERRIDES_DELETED"`) + +* `CLUSTER_OPLOG_RESIZED` (value: `"CLUSTER_OPLOG_RESIZED"`) + +* `CLUSTER_INSTANCE_RESTARTED` (value: `"CLUSTER_INSTANCE_RESTARTED"`) + +* `CLUSTER_INSTANCE_STOP_START` (value: `"CLUSTER_INSTANCE_STOP_START"`) + +* `CLUSTER_INSTANCE_RESYNC_REQUESTED` (value: `"CLUSTER_INSTANCE_RESYNC_REQUESTED"`) + +* `CLUSTER_INSTANCE_RESYNC_CLEARED` (value: `"CLUSTER_INSTANCE_RESYNC_CLEARED"`) + +* `CLUSTER_INSTANCE_UPDATE_REQUESTED` (value: `"CLUSTER_INSTANCE_UPDATE_REQUESTED"`) + +* `CLUSTER_INSTANCE_REPLACED` (value: `"CLUSTER_INSTANCE_REPLACED"`) + +* `CLUSTER_INSTANCE_REPLACE_CLEARED` (value: `"CLUSTER_INSTANCE_REPLACE_CLEARED"`) + +* `CLUSTER_INSTANCE_CONFIG_UPDATED` (value: `"CLUSTER_INSTANCE_CONFIG_UPDATED"`) + +* `CLUSTER_INSTANCE_SSL_ROTATED` (value: `"CLUSTER_INSTANCE_SSL_ROTATED"`) + +* `CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER` (value: `"CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER"`) + +* `CLUSTER_INSTANCE_SSL_REVOKED` (value: `"CLUSTER_INSTANCE_SSL_REVOKED"`) + +* `RELOAD_SSL_ON_PROCESSES` (value: `"RELOAD_SSL_ON_PROCESSES"`) + +* `CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED` (value: `"CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED"`) + +* `DATA_LAKE_QUERY_LOGS_DOWNLOADED` (value: `"DATA_LAKE_QUERY_LOGS_DOWNLOADED"`) + +* `FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED` (value: `"FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED"`) + +* `ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED` (value: `"ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED"`) + +* `MONGODB_LOGS_DOWNLOADED` (value: `"MONGODB_LOGS_DOWNLOADED"`) + +* `MONGOSQLD_LOGS_DOWNLOADED` (value: `"MONGOSQLD_LOGS_DOWNLOADED"`) + +* `MONGODB_USER_ADDED` (value: `"MONGODB_USER_ADDED"`) + +* `MONGODB_USER_DELETED` (value: `"MONGODB_USER_DELETED"`) + +* `MONGODB_USER_X509_CERT_CREATED` (value: `"MONGODB_USER_X509_CERT_CREATED"`) + +* `MONGODB_USER_X509_CERT_REVOKED` (value: `"MONGODB_USER_X509_CERT_REVOKED"`) + +* `MONGODB_USER_UPDATED` (value: `"MONGODB_USER_UPDATED"`) + +* `MONGODB_ROLE_ADDED` (value: `"MONGODB_ROLE_ADDED"`) + +* `MONGODB_ROLE_DELETED` (value: `"MONGODB_ROLE_DELETED"`) + +* `MONGODB_ROLE_UPDATED` (value: `"MONGODB_ROLE_UPDATED"`) + +* `NETWORK_PERMISSION_ENTRY_ADDED` (value: `"NETWORK_PERMISSION_ENTRY_ADDED"`) + +* `NETWORK_PERMISSION_ENTRY_REMOVED` (value: `"NETWORK_PERMISSION_ENTRY_REMOVED"`) + +* `NETWORK_PERMISSION_ENTRY_UPDATED` (value: `"NETWORK_PERMISSION_ENTRY_UPDATED"`) + +* `PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED` (value: `"PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED"`) + +* `PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED` (value: `"PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED"`) + +* `PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED` (value: `"PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED"`) + +* `PLAN_STARTED` (value: `"PLAN_STARTED"`) + +* `PLAN_COMPLETED` (value: `"PLAN_COMPLETED"`) + +* `PLAN_ABANDONED` (value: `"PLAN_ABANDONED"`) + +* `PLAN_FAILURE_COUNT_RESET` (value: `"PLAN_FAILURE_COUNT_RESET"`) + +* `PLAN_ASAP_REQUESTED` (value: `"PLAN_ASAP_REQUESTED"`) + +* `MOVE_SKIPPED` (value: `"MOVE_SKIPPED"`) + +* `PROXY_RESTARTED` (value: `"PROXY_RESTARTED"`) + +* `PROXY_PANICKED` (value: `"PROXY_PANICKED"`) + +* `MAINTENANCE_WINDOW_ADDED` (value: `"MAINTENANCE_WINDOW_ADDED"`) + +* `ATLAS_MAINTENANCE_WINDOW_ADDED` (value: `"ATLAS_MAINTENANCE_WINDOW_ADDED"`) + +* `MAINTENANCE_WINDOW_MODIFIED` (value: `"MAINTENANCE_WINDOW_MODIFIED"`) + +* `ATLAS_MAINTENANCE_WINDOW_MODIFIED` (value: `"ATLAS_MAINTENANCE_WINDOW_MODIFIED"`) + +* `MAINTENANCE_WINDOW_REMOVED` (value: `"MAINTENANCE_WINDOW_REMOVED"`) + +* `ATLAS_MAINTENANCE_WINDOW_REMOVED` (value: `"ATLAS_MAINTENANCE_WINDOW_REMOVED"`) + +* `MAINTENANCE_START_ASAP` (value: `"MAINTENANCE_START_ASAP"`) + +* `ATLAS_MAINTENANCE_START_ASAP` (value: `"ATLAS_MAINTENANCE_START_ASAP"`) + +* `MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW` (value: `"MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW"`) + +* `ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW` (value: `"ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW"`) + +* `MAINTENANCE_DEFERRED` (value: `"MAINTENANCE_DEFERRED"`) + +* `ATLAS_MAINTENANCE_DEFERRED` (value: `"ATLAS_MAINTENANCE_DEFERRED"`) + +* `MAINTENANCE_AUTO_DEFER_ENABLED` (value: `"MAINTENANCE_AUTO_DEFER_ENABLED"`) + +* `ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED` (value: `"ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED"`) + +* `MAINTENANCE_AUTO_DEFER_DISABLED` (value: `"MAINTENANCE_AUTO_DEFER_DISABLED"`) + +* `ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED` (value: `"ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED"`) + +* `SCHEDULED_MAINTENANCE` (value: `"SCHEDULED_MAINTENANCE"`) + +* `PROJECT_SCHEDULED_MAINTENANCE` (value: `"PROJECT_SCHEDULED_MAINTENANCE"`) + +* `PROJECT_LIMIT_UPDATED` (value: `"PROJECT_LIMIT_UPDATED"`) + +* `PROJECT_OPERATIONAL_LIMIT_UPDATED` (value: `"PROJECT_OPERATIONAL_LIMIT_UPDATED"`) + +* `PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED` (value: `"PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED"`) + +* `OS_MAINTENANCE` (value: `"OS_MAINTENANCE"`) + +* `OS_MAINTENANCE_RESTART` (value: `"OS_MAINTENANCE_RESTART"`) + +* `OS_MAINTENANCE_CERTIFICATE_ROTATION_RESTART` (value: `"OS_MAINTENANCE_CERTIFICATE_ROTATION_RESTART"`) + +* `OS_MAINTENANCE_REPLACEMENT` (value: `"OS_MAINTENANCE_REPLACEMENT"`) + +* `FREE_UPGRADE_STARTED` (value: `"FREE_UPGRADE_STARTED"`) + +* `TEST_FAILOVER_REQUESTED` (value: `"TEST_FAILOVER_REQUESTED"`) + +* `USER_SECURITY_SETTINGS_UPDATED` (value: `"USER_SECURITY_SETTINGS_UPDATED"`) + +* `AUDIT_LOG_CONFIGURATION_UPDATED` (value: `"AUDIT_LOG_CONFIGURATION_UPDATED"`) + +* `ENCRYPTION_AT_REST_CONFIGURATION_UPDATED` (value: `"ENCRYPTION_AT_REST_CONFIGURATION_UPDATED"`) + +* `ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED` (value: `"ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED"`) + +* `SET_IMAGE_OVERRIDES` (value: `"SET_IMAGE_OVERRIDES"`) + +* `NDS_SET_IMAGE_OVERRIDES` (value: `"NDS_SET_IMAGE_OVERRIDES"`) + +* `SET_CHEF_TARBALL_URI` (value: `"SET_CHEF_TARBALL_URI"`) + +* `NDS_SET_CHEF_TARBALL_URI` (value: `"NDS_SET_CHEF_TARBALL_URI"`) + +* `RESTRICTED_EMPLOYEE_ACCESS_BYPASS` (value: `"RESTRICTED_EMPLOYEE_ACCESS_BYPASS"`) + +* `REVOKED_EMPLOYEE_ACCESS_BYPASS` (value: `"REVOKED_EMPLOYEE_ACCESS_BYPASS"`) + +* `DEVICE_SYNC_DEBUG_ACCESS_GRANTED` (value: `"DEVICE_SYNC_DEBUG_ACCESS_GRANTED"`) + +* `DEVICE_SYNC_DEBUG_ACCESS_REVOKED` (value: `"DEVICE_SYNC_DEBUG_ACCESS_REVOKED"`) + +* `DEVICE_SYNC_DEBUG_X509_CERT_CREATED` (value: `"DEVICE_SYNC_DEBUG_X509_CERT_CREATED"`) + +* `QUERY_ENGINE_TENANT_CREATED` (value: `"QUERY_ENGINE_TENANT_CREATED"`) + +* `QUERY_ENGINE_TENANT_UPDATED` (value: `"QUERY_ENGINE_TENANT_UPDATED"`) + +* `QUERY_ENGINE_TENANT_REMOVED` (value: `"QUERY_ENGINE_TENANT_REMOVED"`) + +* `FEDERATED_DATABASE_CREATED` (value: `"FEDERATED_DATABASE_CREATED"`) + +* `FEDERATED_DATABASE_UPDATED` (value: `"FEDERATED_DATABASE_UPDATED"`) + +* `FEDERATED_DATABASE_REMOVED` (value: `"FEDERATED_DATABASE_REMOVED"`) + +* `TENANT_CLUSTER_UPGRADE_FROM_MTM` (value: `"TENANT_CLUSTER_UPGRADE_FROM_MTM"`) + +* `TENANT_SNAPSHOT_FAILED` (value: `"TENANT_SNAPSHOT_FAILED"`) + +* `TENANT_RESTORE_FAILED` (value: `"TENANT_RESTORE_FAILED"`) + +* `SAMPLE_DATASET_LOAD_REQUESTED` (value: `"SAMPLE_DATASET_LOAD_REQUESTED"`) + +* `CUSTOMER_X509_CRL_UPDATED` (value: `"CUSTOMER_X509_CRL_UPDATED"`) + +* `CONTAINER_SUBNETS_UPDATE_REQUESTED` (value: `"CONTAINER_SUBNETS_UPDATE_REQUESTED"`) + +* `CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED` (value: `"CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED"`) + +* `ONLINE_ARCHIVE_CREATED` (value: `"ONLINE_ARCHIVE_CREATED"`) + +* `ONLINE_ARCHIVE_DELETED` (value: `"ONLINE_ARCHIVE_DELETED"`) + +* `ONLINE_ARCHIVE_UPDATED` (value: `"ONLINE_ARCHIVE_UPDATED"`) + +* `ONLINE_ARCHIVE_PAUSE_REQUESTED` (value: `"ONLINE_ARCHIVE_PAUSE_REQUESTED"`) + +* `ONLINE_ARCHIVE_PAUSED` (value: `"ONLINE_ARCHIVE_PAUSED"`) + +* `ONLINE_ARCHIVE_ACTIVE` (value: `"ONLINE_ARCHIVE_ACTIVE"`) + +* `ONLINE_ARCHIVE_ORPHANED` (value: `"ONLINE_ARCHIVE_ORPHANED"`) + +* `ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED` (value: `"ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED"`) + +* `ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED` (value: `"ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED"`) + +* `ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED` (value: `"ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED"`) + +* `CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED` (value: `"CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED"`) + +* `CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED` (value: `"CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED"`) + +* `CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED` (value: `"CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED"`) + +* `CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED` (value: `"CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED"`) + +* `CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED` (value: `"CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED"`) + +* `CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED` (value: `"CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED"`) + +* `PENDING_INDEXES_DELETED` (value: `"PENDING_INDEXES_DELETED"`) + +* `PENDING_INDEXES_CANCELED` (value: `"PENDING_INDEXES_CANCELED"`) + +* `PROCESS_RESTART_REQUESTED` (value: `"PROCESS_RESTART_REQUESTED"`) + +* `AUTO_HEALING_ACTION` (value: `"AUTO_HEALING_ACTION"`) + +* `EXTRA_MAINTENANCE_DEFERRAL_GRANTED` (value: `"EXTRA_MAINTENANCE_DEFERRAL_GRANTED"`) + +* `ADMIN_NOTE_UPDATED` (value: `"ADMIN_NOTE_UPDATED"`) + +* `GROUP_AUTOMATION_CONFIG_PUBLISHED` (value: `"GROUP_AUTOMATION_CONFIG_PUBLISHED"`) + +* `CLUSTER_AUTOMATION_CONFIG_PUBLISHED` (value: `"CLUSTER_AUTOMATION_CONFIG_PUBLISHED"`) + +* `CLUSTER_LINKED_TO_VERCEL` (value: `"CLUSTER_LINKED_TO_VERCEL"`) + +* `CLUSTER_UNLINKED_FROM_VERCEL` (value: `"CLUSTER_UNLINKED_FROM_VERCEL"`) + +* `INGESTION_PIPELINE_DELETED` (value: `"INGESTION_PIPELINE_DELETED"`) + +* `INGESTION_PIPELINE_DESTROYED` (value: `"INGESTION_PIPELINE_DESTROYED"`) + +* `INGESTION_PIPELINE_CREATED` (value: `"INGESTION_PIPELINE_CREATED"`) + +* `INGESTION_PIPELINE_UPDATED` (value: `"INGESTION_PIPELINE_UPDATED"`) + +* `OS_TUNED_FILE_OVERRIDES` (value: `"OS_TUNED_FILE_OVERRIDES"`) + +* `OS_TUNE_FILE_OVERRIDES` (value: `"OS_TUNE_FILE_OVERRIDES"`) + +* `CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED` (value: `"CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED"`) + +* `CLUSTER_FORCE_PLANNED` (value: `"CLUSTER_FORCE_PLANNED"`) + +* `DATA_PROCESSING_REGION_UPDATED` (value: `"DATA_PROCESSING_REGION_UPDATED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE"`) + +* `UIS_PANICKED` (value: `"UIS_PANICKED"`) + +* `TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL` (value: `"TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL"`) + +* `TENANT_UPGRADE_TO_SERVERLESS_FAILED` (value: `"TENANT_UPGRADE_TO_SERVERLESS_FAILED"`) + +* `CLUSTER_FORCE_RECONFIG_REQUESTED` (value: `"CLUSTER_FORCE_RECONFIG_REQUESTED"`) + +* `PROJECT_BYPASSED_MAINTENANCE` (value: `"PROJECT_BYPASSED_MAINTENANCE"`) + +* `DATA_FEDERATION_QUERY_LIMIT_CONFIGURED` (value: `"DATA_FEDERATION_QUERY_LIMIT_CONFIGURED"`) + +* `DATA_FEDERATION_QUERY_LIMIT_DELETED` (value: `"DATA_FEDERATION_QUERY_LIMIT_DELETED"`) + +* `DATA_API_SETUP_FOR_VERCEL` (value: `"DATA_API_SETUP_FOR_VERCEL"`) + +* `ADMIN_CLUSTER_LOCK_UPDATED` (value: `"ADMIN_CLUSTER_LOCK_UPDATED"`) + +* `COMPUTE_AUTO_SCALE_INITIATED` (value: `"COMPUTE_AUTO_SCALE_INITIATED"`) + +* `DISK_AUTO_SCALE_INITIATED` (value: `"DISK_AUTO_SCALE_INITIATED"`) + +* `COMPUTE_AUTO_SCALE_INITIATED_BASE` (value: `"COMPUTE_AUTO_SCALE_INITIATED_BASE"`) + +* `COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS` (value: `"COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS"`) + +* `MAINTENANCE_IN_ADVANCED` (value: `"MAINTENANCE_IN_ADVANCED"`) + +* `MAINTENANCE_AUTO_DEFERRED` (value: `"MAINTENANCE_AUTO_DEFERRED"`) + +* `MAINTENANCE_STARTED` (value: `"MAINTENANCE_STARTED"`) + +* `MAINTENANCE_NO_LONGER_NEEDED` (value: `"MAINTENANCE_NO_LONGER_NEEDED"`) + +* `SERVERLESS_AUTO_SCALING_INITIATED` (value: `"SERVERLESS_AUTO_SCALING_INITIATED"`) + +* `SERVERLESS_VERTICAL_SCALING_INITIATED` (value: `"SERVERLESS_VERTICAL_SCALING_INITIATED"`) + +* `SERVERLESS_HORIZONTAL_SCALING_INITIATED` (value: `"SERVERLESS_HORIZONTAL_SCALING_INITIATED"`) + +* `SERVERLESS_INSTANCE_CREATED` (value: `"SERVERLESS_INSTANCE_CREATED"`) + +* `SERVERLESS_INSTANCE_READY` (value: `"SERVERLESS_INSTANCE_READY"`) + +* `SERVERLESS_INSTANCE_UPDATE_SUBMITTED` (value: `"SERVERLESS_INSTANCE_UPDATE_SUBMITTED"`) + +* `SERVERLESS_INSTANCE_UPDATE_STARTED` (value: `"SERVERLESS_INSTANCE_UPDATE_STARTED"`) + +* `SERVERLESS_INSTANCE_UPDATE_COMPLETED` (value: `"SERVERLESS_INSTANCE_UPDATE_COMPLETED"`) + +* `SERVERLESS_INSTANCE_DELETE_SUBMITTED` (value: `"SERVERLESS_INSTANCE_DELETE_SUBMITTED"`) + +* `SERVERLESS_INSTANCE_DELETED` (value: `"SERVERLESS_INSTANCE_DELETED"`) + +* `SERVERLESS_INSTANCE_BLOCKED` (value: `"SERVERLESS_INSTANCE_BLOCKED"`) + +* `SERVERLESS_INSTANCE_UNBLOCKED` (value: `"SERVERLESS_INSTANCE_UNBLOCKED"`) + +* `TENANT_ENDPOINT_CREATED` (value: `"TENANT_ENDPOINT_CREATED"`) + +* `TENANT_ENDPOINT_RESERVED` (value: `"TENANT_ENDPOINT_RESERVED"`) + +* `TENANT_ENDPOINT_RESERVATION_FAILED` (value: `"TENANT_ENDPOINT_RESERVATION_FAILED"`) + +* `TENANT_ENDPOINT_UPDATED` (value: `"TENANT_ENDPOINT_UPDATED"`) + +* `TENANT_ENDPOINT_INITIATING` (value: `"TENANT_ENDPOINT_INITIATING"`) + +* `TENANT_ENDPOINT_AVAILABLE` (value: `"TENANT_ENDPOINT_AVAILABLE"`) + +* `TENANT_ENDPOINT_FAILED` (value: `"TENANT_ENDPOINT_FAILED"`) + +* `TENANT_ENDPOINT_DELETING` (value: `"TENANT_ENDPOINT_DELETING"`) + +* `TENANT_ENDPOINT_DELETED` (value: `"TENANT_ENDPOINT_DELETED"`) + +* `TENANT_ENDPOINT_EXPIRED` (value: `"TENANT_ENDPOINT_EXPIRED"`) + +* `TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED` (value: `"TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED"`) + +* `TENANT_ENDPOINT_SERVICE_CREATED` (value: `"TENANT_ENDPOINT_SERVICE_CREATED"`) + +* `TENANT_ENDPOINT_SERVICE_AVAILABLE` (value: `"TENANT_ENDPOINT_SERVICE_AVAILABLE"`) + +* `TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED` (value: `"TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED"`) + +* `TENANT_ENDPOINT_SERVICE_DELETED` (value: `"TENANT_ENDPOINT_SERVICE_DELETED"`) + +* `TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED` (value: `"TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED"`) + +* `TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED` (value: `"TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED"`) + +* `NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED` (value: `"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED"`) + +* `NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK` (value: `"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK"`) + +* `NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED` (value: `"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED"`) + +* `NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK` (value: `"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK"`) + +* `NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED` (value: `"NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED"`) + +* `NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK` (value: `"NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK"`) + +* `ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK` (value: `"ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK"`) + +* `ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED` (value: `"ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED"`) + +* `ONLINE_ARCHIVE_UP_TO_DATE` (value: `"ONLINE_ARCHIVE_UP_TO_DATE"`) + +* `ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED` (value: `"ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED"`) + +* `ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK` (value: `"ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK"`) + +* `ENDPOINT_SERVICE_CREATED` (value: `"ENDPOINT_SERVICE_CREATED"`) + +* `ENDPOINT_SERVICE_DELETED` (value: `"ENDPOINT_SERVICE_DELETED"`) + +* `INTERFACE_ENDPOINT_CREATED` (value: `"INTERFACE_ENDPOINT_CREATED"`) + +* `INTERFACE_ENDPOINT_DELETED` (value: `"INTERFACE_ENDPOINT_DELETED"`) + +* `INTERFACE_ENDPOINT_PATCHED` (value: `"INTERFACE_ENDPOINT_PATCHED"`) + +* `PRIMARY_ELECTED` (value: `"PRIMARY_ELECTED"`) + +* `REPLICATION_OPLOG_WINDOW_HEALTHY` (value: `"REPLICATION_OPLOG_WINDOW_HEALTHY"`) + +* `REPLICATION_OPLOG_WINDOW_RUNNING_OUT` (value: `"REPLICATION_OPLOG_WINDOW_RUNNING_OUT"`) + +* `ONE_PRIMARY` (value: `"ONE_PRIMARY"`) + +* `NO_PRIMARY` (value: `"NO_PRIMARY"`) + +* `TOO_MANY_ELECTIONS` (value: `"TOO_MANY_ELECTIONS"`) + +* `SERVERLESS_DEPLOYMENT_CREATED` (value: `"SERVERLESS_DEPLOYMENT_CREATED"`) + +* `SERVERLESS_DEPLOYMENT_DELETED` (value: `"SERVERLESS_DEPLOYMENT_DELETED"`) + +* `SERVERLESS_DEPLOYMENT_UPDATED` (value: `"SERVERLESS_DEPLOYMENT_UPDATED"`) + +* `SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED` (value: `"SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED"`) + +* `SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED` (value: `"SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED"`) + +* `SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED` (value: `"SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED"`) + +* `SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED` (value: `"SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED"`) + +* `INSIDE_SERVERLESS_METRIC_THRESHOLD` (value: `"INSIDE_SERVERLESS_METRIC_THRESHOLD"`) + +* `OUTSIDE_SERVERLESS_METRIC_THRESHOLD` (value: `"OUTSIDE_SERVERLESS_METRIC_THRESHOLD"`) + +* `SETUP_SERVERLESS_INITIATED` (value: `"SETUP_SERVERLESS_INITIATED"`) + +* `CASE_CREATED` (value: `"CASE_CREATED"`) + +* `SUPPORT_EMAILS_SENT_SUCCESSFULLY` (value: `"SUPPORT_EMAILS_SENT_SUCCESSFULLY"`) + +* `SUPPORT_EMAILS_SENT_FAILURE` (value: `"SUPPORT_EMAILS_SENT_FAILURE"`) + +* `TEAM_ADDED_TO_GROUP` (value: `"TEAM_ADDED_TO_GROUP"`) + +* `TEAM_REMOVED_FROM_GROUP` (value: `"TEAM_REMOVED_FROM_GROUP"`) + +* `TEAM_ROLES_MODIFIED` (value: `"TEAM_ROLES_MODIFIED"`) + +* `TENANT_SNAPSHOT_STARTED_AUDIT` (value: `"TENANT_SNAPSHOT_STARTED_AUDIT"`) + +* `TENANT_SNAPSHOT_COMPLETED_AUDIT` (value: `"TENANT_SNAPSHOT_COMPLETED_AUDIT"`) + +* `TENANT_SNAPSHOT_DELETED_AUDIT` (value: `"TENANT_SNAPSHOT_DELETED_AUDIT"`) + +* `TENANT_RESTORE_REQUESTED_AUDIT` (value: `"TENANT_RESTORE_REQUESTED_AUDIT"`) + +* `TENANT_RESTORE_COMPLETED_AUDIT` (value: `"TENANT_RESTORE_COMPLETED_AUDIT"`) + +* `TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT` (value: `"TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT"`) + +* `JOINED_GROUP` (value: `"JOINED_GROUP"`) + +* `REMOVED_FROM_GROUP` (value: `"REMOVED_FROM_GROUP"`) + +* `INVITED_TO_GROUP` (value: `"INVITED_TO_GROUP"`) + +* `REQUESTED_TO_JOIN_GROUP` (value: `"REQUESTED_TO_JOIN_GROUP"`) + +* `GROUP_INVITATION_DELETED` (value: `"GROUP_INVITATION_DELETED"`) + +* `USER_ROLES_CHANGED_AUDIT` (value: `"USER_ROLES_CHANGED_AUDIT"`) + +* `JOIN_GROUP_REQUEST_DENIED_AUDIT` (value: `"JOIN_GROUP_REQUEST_DENIED_AUDIT"`) + +* `JOIN_GROUP_REQUEST_APPROVED_AUDIT` (value: `"JOIN_GROUP_REQUEST_APPROVED_AUDIT"`) + +* `CLUSTER_VERSION_FIXED` (value: `"CLUSTER_VERSION_FIXED"`) + +* `CLUSTER_VERSION_UNFIXED` (value: `"CLUSTER_VERSION_UNFIXED"`) + +* `CLUSTER_FCV_FIXED` (value: `"CLUSTER_FCV_FIXED"`) + +* `CLUSTER_FCV_UNFIXED` (value: `"CLUSTER_FCV_UNFIXED"`) + +* `AGENT_VERSION_FIXED` (value: `"AGENT_VERSION_FIXED"`) + +* `AGENT_VERSION_UNFIXED` (value: `"AGENT_VERSION_UNFIXED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EventTypeForOrg.md b/docs/docs/EventTypeForOrg.md new file mode 100644 index 00000000..e7cbd6c3 --- /dev/null +++ b/docs/docs/EventTypeForOrg.md @@ -0,0 +1,393 @@ +# EventTypeForOrg + +## Enum + + +* `ALERT_ACKNOWLEDGED_AUDIT` (value: `"ALERT_ACKNOWLEDGED_AUDIT"`) + +* `ALERT_UNACKNOWLEDGED_AUDIT` (value: `"ALERT_UNACKNOWLEDGED_AUDIT"`) + +* `ALERT_CONFIG_DISABLED_AUDIT` (value: `"ALERT_CONFIG_DISABLED_AUDIT"`) + +* `ALERT_CONFIG_ENABLED_AUDIT` (value: `"ALERT_CONFIG_ENABLED_AUDIT"`) + +* `ALERT_CONFIG_ADDED_AUDIT` (value: `"ALERT_CONFIG_ADDED_AUDIT"`) + +* `ALERT_CONFIG_DELETED_AUDIT` (value: `"ALERT_CONFIG_DELETED_AUDIT"`) + +* `ALERT_CONFIG_CHANGED_AUDIT` (value: `"ALERT_CONFIG_CHANGED_AUDIT"`) + +* `API_KEY_CREATED` (value: `"API_KEY_CREATED"`) + +* `API_KEY_DELETED` (value: `"API_KEY_DELETED"`) + +* `API_KEY_ACCESS_LIST_ENTRY_ADDED` (value: `"API_KEY_ACCESS_LIST_ENTRY_ADDED"`) + +* `API_KEY_ACCESS_LIST_ENTRY_DELETED` (value: `"API_KEY_ACCESS_LIST_ENTRY_DELETED"`) + +* `API_KEY_ROLES_CHANGED` (value: `"API_KEY_ROLES_CHANGED"`) + +* `API_KEY_DESCRIPTION_CHANGED` (value: `"API_KEY_DESCRIPTION_CHANGED"`) + +* `API_KEY_ADDED_TO_GROUP` (value: `"API_KEY_ADDED_TO_GROUP"`) + +* `API_KEY_REMOVED_FROM_GROUP` (value: `"API_KEY_REMOVED_FROM_GROUP"`) + +* `API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED"`) + +* `API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED` (value: `"API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED"`) + +* `CHARGE_SUCCEEDED` (value: `"CHARGE_SUCCEEDED"`) + +* `CHARGE_FAILED` (value: `"CHARGE_FAILED"`) + +* `CHARGE_PROCESSING` (value: `"CHARGE_PROCESSING"`) + +* `CHARGE_PENDING_REVERSAL` (value: `"CHARGE_PENDING_REVERSAL"`) + +* `BRAINTREE_CHARGE_FAILED` (value: `"BRAINTREE_CHARGE_FAILED"`) + +* `INVOICE_CLOSED` (value: `"INVOICE_CLOSED"`) + +* `CHECK_PAYMENT_RECEIVED` (value: `"CHECK_PAYMENT_RECEIVED"`) + +* `WIRE_TRANSFER_PAYMENT_RECEIVED` (value: `"WIRE_TRANSFER_PAYMENT_RECEIVED"`) + +* `DISCOUNT_APPLIED` (value: `"DISCOUNT_APPLIED"`) + +* `CREDIT_ISSUED` (value: `"CREDIT_ISSUED"`) + +* `CREDIT_PULLED_FWD` (value: `"CREDIT_PULLED_FWD"`) + +* `CREDIT_END_DATE_MODIFIED` (value: `"CREDIT_END_DATE_MODIFIED"`) + +* `PROMO_CODE_APPLIED` (value: `"PROMO_CODE_APPLIED"`) + +* `PAYMENT_FORGIVEN` (value: `"PAYMENT_FORGIVEN"`) + +* `REFUND_ISSUED` (value: `"REFUND_ISSUED"`) + +* `ACCOUNT_DOWNGRADED` (value: `"ACCOUNT_DOWNGRADED"`) + +* `ACCOUNT_UPGRADED` (value: `"ACCOUNT_UPGRADED"`) + +* `ACCOUNT_MODIFIED` (value: `"ACCOUNT_MODIFIED"`) + +* `SUPPORT_PLAN_ACTIVATED` (value: `"SUPPORT_PLAN_ACTIVATED"`) + +* `SUPPORT_PLAN_CANCELLED` (value: `"SUPPORT_PLAN_CANCELLED"`) + +* `SUPPORT_PLAN_CANCELLATION_SCHEDULED` (value: `"SUPPORT_PLAN_CANCELLATION_SCHEDULED"`) + +* `INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC` (value: `"INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC"`) + +* `INVOICE_ADDRESS_CHANGED` (value: `"INVOICE_ADDRESS_CHANGED"`) + +* `INVOICE_ADDRESS_ADDED` (value: `"INVOICE_ADDRESS_ADDED"`) + +* `PREPAID_PLAN_ACTIVATED` (value: `"PREPAID_PLAN_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_ACTIVATED` (value: `"ELASTIC_INVOICING_MODE_ACTIVATED"`) + +* `ELASTIC_INVOICING_MODE_DEACTIVATED` (value: `"ELASTIC_INVOICING_MODE_DEACTIVATED"`) + +* `TERMINATE_PAID_SERVICES` (value: `"TERMINATE_PAID_SERVICES"`) + +* `BILLING_EMAIL_ADDRESS_ADDED` (value: `"BILLING_EMAIL_ADDRESS_ADDED"`) + +* `BILLING_EMAIL_ADDRESS_CHANGED` (value: `"BILLING_EMAIL_ADDRESS_CHANGED"`) + +* `BILLING_EMAIL_ADDRESS_REMOVED` (value: `"BILLING_EMAIL_ADDRESS_REMOVED"`) + +* `AWS_BILLING_ACCOUNT_CREDIT_ISSUED` (value: `"AWS_BILLING_ACCOUNT_CREDIT_ISSUED"`) + +* `GCP_BILLING_ACCOUNT_CREDIT_ISSUED` (value: `"GCP_BILLING_ACCOUNT_CREDIT_ISSUED"`) + +* `CREDIT_SFOLI_MODIFIED` (value: `"CREDIT_SFOLI_MODIFIED"`) + +* `CREDIT_SFOLID_MODIFIED` (value: `"CREDIT_SFOLID_MODIFIED"`) + +* `CREDIT_AMOUNT_MODIFIED` (value: `"CREDIT_AMOUNT_MODIFIED"`) + +* `PREPAID_PLAN_MODIFIED` (value: `"PREPAID_PLAN_MODIFIED"`) + +* `AWS_USAGE_REPORTED` (value: `"AWS_USAGE_REPORTED"`) + +* `AZURE_USAGE_REPORTED` (value: `"AZURE_USAGE_REPORTED"`) + +* `GCP_USAGE_REPORTED` (value: `"GCP_USAGE_REPORTED"`) + +* `BECAME_PAYING_ORG` (value: `"BECAME_PAYING_ORG"`) + +* `NEW_LINKED_ORG` (value: `"NEW_LINKED_ORG"`) + +* `UNLINKED_ORG` (value: `"UNLINKED_ORG"`) + +* `ORG_LINKED_TO_PAYING_ORG` (value: `"ORG_LINKED_TO_PAYING_ORG"`) + +* `ORG_UNLINKED_FROM_PAYING_ORG` (value: `"ORG_UNLINKED_FROM_PAYING_ORG"`) + +* `PAYMENT_UPDATED_THROUGH_API` (value: `"PAYMENT_UPDATED_THROUGH_API"`) + +* `AZURE_BILLING_ACCOUNT_CREDIT_ISSUED` (value: `"AZURE_BILLING_ACCOUNT_CREDIT_ISSUED"`) + +* `CREDIT_START_DATE_MODIFIED` (value: `"CREDIT_START_DATE_MODIFIED"`) + +* `CREDIT_ELASTIC_INVOICING_MODIFIED` (value: `"CREDIT_ELASTIC_INVOICING_MODIFIED"`) + +* `CREDIT_TYPE_MODIFIED` (value: `"CREDIT_TYPE_MODIFIED"`) + +* `CREDIT_AMOUNT_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_CENTS_MODIFIED"`) + +* `CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED` (value: `"CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED"`) + +* `CREDIT_TOTAL_BILLED_CENTS_MODIFIED` (value: `"CREDIT_TOTAL_BILLED_CENTS_MODIFIED"`) + +* `CREDIT_AWS_CUSTOMER_ID_MODIFIED` (value: `"CREDIT_AWS_CUSTOMER_ID_MODIFIED"`) + +* `CREDIT_AWS_PRODUCT_CODE_MODIFIED` (value: `"CREDIT_AWS_PRODUCT_CODE_MODIFIED"`) + +* `CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED` (value: `"CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED"`) + +* `CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED` (value: `"CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED"`) + +* `FEDERATION_SETTINGS_CREATED` (value: `"FEDERATION_SETTINGS_CREATED"`) + +* `FEDERATION_SETTINGS_DELETED` (value: `"FEDERATION_SETTINGS_DELETED"`) + +* `FEDERATION_SETTINGS_UPDATED` (value: `"FEDERATION_SETTINGS_UPDATED"`) + +* `IDENTITY_PROVIDER_CREATED` (value: `"IDENTITY_PROVIDER_CREATED"`) + +* `IDENTITY_PROVIDER_UPDATED` (value: `"IDENTITY_PROVIDER_UPDATED"`) + +* `IDENTITY_PROVIDER_DELETED` (value: `"IDENTITY_PROVIDER_DELETED"`) + +* `IDENTITY_PROVIDER_ACTIVATED` (value: `"IDENTITY_PROVIDER_ACTIVATED"`) + +* `IDENTITY_PROVIDER_DEACTIVATED` (value: `"IDENTITY_PROVIDER_DEACTIVATED"`) + +* `DOMAINS_ASSOCIATED` (value: `"DOMAINS_ASSOCIATED"`) + +* `DOMAIN_CREATED` (value: `"DOMAIN_CREATED"`) + +* `DOMAIN_DELETED` (value: `"DOMAIN_DELETED"`) + +* `DOMAIN_VERIFIED` (value: `"DOMAIN_VERIFIED"`) + +* `ORG_SETTINGS_CONFIGURED` (value: `"ORG_SETTINGS_CONFIGURED"`) + +* `ORG_SETTINGS_UPDATED` (value: `"ORG_SETTINGS_UPDATED"`) + +* `ORG_SETTINGS_DELETED` (value: `"ORG_SETTINGS_DELETED"`) + +* `RESTRICT_ORG_MEMBERSHIP_ENABLED` (value: `"RESTRICT_ORG_MEMBERSHIP_ENABLED"`) + +* `RESTRICT_ORG_MEMBERSHIP_DISABLED` (value: `"RESTRICT_ORG_MEMBERSHIP_DISABLED"`) + +* `ROLE_MAPPING_CREATED` (value: `"ROLE_MAPPING_CREATED"`) + +* `ROLE_MAPPING_UPDATED` (value: `"ROLE_MAPPING_UPDATED"`) + +* `ROLE_MAPPING_DELETED` (value: `"ROLE_MAPPING_DELETED"`) + +* `GROUP_DELETED` (value: `"GROUP_DELETED"`) + +* `GROUP_CREATED` (value: `"GROUP_CREATED"`) + +* `GROUP_MOVED` (value: `"GROUP_MOVED"`) + +* `MLAB_MIGRATION_COMPLETED` (value: `"MLAB_MIGRATION_COMPLETED"`) + +* `MLAB_MIGRATION_TARGET_CLUSTER_CREATED` (value: `"MLAB_MIGRATION_TARGET_CLUSTER_CREATED"`) + +* `MLAB_MIGRATION_DATABASE_USERS_IMPORTED` (value: `"MLAB_MIGRATION_DATABASE_USERS_IMPORTED"`) + +* `MLAB_MIGRATION_IP_WHITELIST_IMPORTED` (value: `"MLAB_MIGRATION_IP_WHITELIST_IMPORTED"`) + +* `MLAB_MIGRATION_TARGET_CLUSTER_SET` (value: `"MLAB_MIGRATION_TARGET_CLUSTER_SET"`) + +* `MLAB_MIGRATION_DATABASE_RENAMED` (value: `"MLAB_MIGRATION_DATABASE_RENAMED"`) + +* `MLAB_MIGRATION_LIVE_IMPORT_STARTED` (value: `"MLAB_MIGRATION_LIVE_IMPORT_STARTED"`) + +* `MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER` (value: `"MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER"`) + +* `MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE` (value: `"MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE"`) + +* `MLAB_MIGRATION_LIVE_IMPORT_ERROR` (value: `"MLAB_MIGRATION_LIVE_IMPORT_ERROR"`) + +* `MLAB_MIGRATION_LIVE_IMPORT_CANCELLED` (value: `"MLAB_MIGRATION_LIVE_IMPORT_CANCELLED"`) + +* `MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED` (value: `"MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED"`) + +* `MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED` (value: `"MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED"`) + +* `MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED` (value: `"MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED"`) + +* `MLAB_MIGRATION_SUPPORT_PLAN_SELECTED` (value: `"MLAB_MIGRATION_SUPPORT_PLAN_SELECTED"`) + +* `MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT` (value: `"MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT"`) + +* `ORG_LIMIT_UPDATED` (value: `"ORG_LIMIT_UPDATED"`) + +* `ORG_CREATED` (value: `"ORG_CREATED"`) + +* `ORG_CREDIT_CARD_ADDED` (value: `"ORG_CREDIT_CARD_ADDED"`) + +* `ORG_CREDIT_CARD_UPDATED` (value: `"ORG_CREDIT_CARD_UPDATED"`) + +* `ORG_CREDIT_CARD_CURRENT` (value: `"ORG_CREDIT_CARD_CURRENT"`) + +* `ORG_CREDIT_CARD_ABOUT_TO_EXPIRE` (value: `"ORG_CREDIT_CARD_ABOUT_TO_EXPIRE"`) + +* `ORG_PAYPAL_LINKED` (value: `"ORG_PAYPAL_LINKED"`) + +* `ORG_PAYPAL_UPDATED` (value: `"ORG_PAYPAL_UPDATED"`) + +* `ORG_PAYPAL_CANCELLED` (value: `"ORG_PAYPAL_CANCELLED"`) + +* `ORG_OVERRIDE_PAYMENT_METHOD_ADDED` (value: `"ORG_OVERRIDE_PAYMENT_METHOD_ADDED"`) + +* `ORG_ACTIVATED` (value: `"ORG_ACTIVATED"`) + +* `ORG_TEMPORARILY_ACTIVATED` (value: `"ORG_TEMPORARILY_ACTIVATED"`) + +* `ORG_SUSPENDED` (value: `"ORG_SUSPENDED"`) + +* `ORG_ADMIN_SUSPENDED` (value: `"ORG_ADMIN_SUSPENDED"`) + +* `ORG_ADMIN_LOCKED` (value: `"ORG_ADMIN_LOCKED"`) + +* `ORG_CLUSTERS_DELETED` (value: `"ORG_CLUSTERS_DELETED"`) + +* `ORG_CLUSTERS_PAUSED` (value: `"ORG_CLUSTERS_PAUSED"`) + +* `ORG_LOCKED` (value: `"ORG_LOCKED"`) + +* `ORG_RENAMED` (value: `"ORG_RENAMED"`) + +* `ALL_ORG_USERS_HAVE_MFA` (value: `"ALL_ORG_USERS_HAVE_MFA"`) + +* `ORG_USERS_WITHOUT_MFA` (value: `"ORG_USERS_WITHOUT_MFA"`) + +* `ORG_INVOICE_UNDER_THRESHOLD` (value: `"ORG_INVOICE_UNDER_THRESHOLD"`) + +* `ORG_INVOICE_OVER_THRESHOLD` (value: `"ORG_INVOICE_OVER_THRESHOLD"`) + +* `ORG_DAILY_BILL_UNDER_THRESHOLD` (value: `"ORG_DAILY_BILL_UNDER_THRESHOLD"`) + +* `ORG_DAILY_BILL_OVER_THRESHOLD` (value: `"ORG_DAILY_BILL_OVER_THRESHOLD"`) + +* `ORG_GROUP_CHARGES_UNDER_THRESHOLD` (value: `"ORG_GROUP_CHARGES_UNDER_THRESHOLD"`) + +* `ORG_GROUP_CHARGES_OVER_THRESHOLD` (value: `"ORG_GROUP_CHARGES_OVER_THRESHOLD"`) + +* `ORG_TWO_FACTOR_AUTH_REQUIRED` (value: `"ORG_TWO_FACTOR_AUTH_REQUIRED"`) + +* `ORG_TWO_FACTOR_AUTH_OPTIONAL` (value: `"ORG_TWO_FACTOR_AUTH_OPTIONAL"`) + +* `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` (value: `"ORG_PUBLIC_API_ACCESS_LIST_REQUIRED"`) + +* `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` (value: `"ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED"`) + +* `ORG_EMPLOYEE_ACCESS_RESTRICTED` (value: `"ORG_EMPLOYEE_ACCESS_RESTRICTED"`) + +* `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` (value: `"ORG_EMPLOYEE_ACCESS_UNRESTRICTED"`) + +* `ORG_SFDC_ACCOUNT_ID_CHANGED` (value: `"ORG_SFDC_ACCOUNT_ID_CHANGED"`) + +* `ORG_CONNECTED_TO_MLAB` (value: `"ORG_CONNECTED_TO_MLAB"`) + +* `ORG_DISCONNECTED_FROM_MLAB` (value: `"ORG_DISCONNECTED_FROM_MLAB"`) + +* `ORG_IDP_CERTIFICATE_CURRENT` (value: `"ORG_IDP_CERTIFICATE_CURRENT"`) + +* `ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE` (value: `"ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE"`) + +* `ORG_CONNECTED_TO_VERCEL` (value: `"ORG_CONNECTED_TO_VERCEL"`) + +* `ORG_DISCONNECTED_FROM_VERCEL` (value: `"ORG_DISCONNECTED_FROM_VERCEL"`) + +* `ORG_DISCONNECTED_TO_VERCEL` (value: `"ORG_DISCONNECTED_TO_VERCEL"`) + +* `ORG_CONNECTION_UNINSTALLED_FROM_VERCEL` (value: `"ORG_CONNECTION_UNINSTALLED_FROM_VERCEL"`) + +* `ORG_UI_IP_ACCESS_LIST_ENABLED` (value: `"ORG_UI_IP_ACCESS_LIST_ENABLED"`) + +* `ORG_UI_IP_ACCESS_LIST_DISABLED` (value: `"ORG_UI_IP_ACCESS_LIST_DISABLED"`) + +* `ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES` (value: `"ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES"`) + +* `AWS_SELF_SERVE_ACCOUNT_LINKED` (value: `"AWS_SELF_SERVE_ACCOUNT_LINKED"`) + +* `AWS_SELF_SERVE_ACCOUNT_LINK_PENDING` (value: `"AWS_SELF_SERVE_ACCOUNT_LINK_PENDING"`) + +* `AWS_SELF_SERVE_ACCOUNT_CANCELLED` (value: `"AWS_SELF_SERVE_ACCOUNT_CANCELLED"`) + +* `AWS_SELF_SERVE_ACCOUNT_LINK_FAILED` (value: `"AWS_SELF_SERVE_ACCOUNT_LINK_FAILED"`) + +* `GCP_SELF_SERVE_ACCOUNT_LINK_PENDING` (value: `"GCP_SELF_SERVE_ACCOUNT_LINK_PENDING"`) + +* `GCP_SELF_SERVE_ACCOUNT_LINK_FAILED` (value: `"GCP_SELF_SERVE_ACCOUNT_LINK_FAILED"`) + +* `AZURE_SELF_SERVE_ACCOUNT_LINKED` (value: `"AZURE_SELF_SERVE_ACCOUNT_LINKED"`) + +* `AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING` (value: `"AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING"`) + +* `AZURE_SELF_SERVE_ACCOUNT_CANCELLED` (value: `"AZURE_SELF_SERVE_ACCOUNT_CANCELLED"`) + +* `AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED` (value: `"AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED"`) + +* `GCP_SELF_SERVE_ACCOUNT_LINKED` (value: `"GCP_SELF_SERVE_ACCOUNT_LINKED"`) + +* `GCP_SELF_SERVE_ACCOUNT_CANCELLED` (value: `"GCP_SELF_SERVE_ACCOUNT_CANCELLED"`) + +* `ORG_POLICY_CREATED` (value: `"ORG_POLICY_CREATED"`) + +* `ORG_POLICY_DELETED` (value: `"ORG_POLICY_DELETED"`) + +* `ORG_POLICY_EDITED` (value: `"ORG_POLICY_EDITED"`) + +* `ORG_POLICY_CLONED` (value: `"ORG_POLICY_CLONED"`) + +* `SUPPORT_EMAILS_SENT_SUCCESSFULLY` (value: `"SUPPORT_EMAILS_SENT_SUCCESSFULLY"`) + +* `SUPPORT_EMAILS_SENT_FAILURE` (value: `"SUPPORT_EMAILS_SENT_FAILURE"`) + +* `TEAM_CREATED` (value: `"TEAM_CREATED"`) + +* `TEAM_DELETED` (value: `"TEAM_DELETED"`) + +* `TEAM_UPDATED` (value: `"TEAM_UPDATED"`) + +* `TEAM_NAME_CHANGED` (value: `"TEAM_NAME_CHANGED"`) + +* `TEAM_ADDED_TO_GROUP` (value: `"TEAM_ADDED_TO_GROUP"`) + +* `TEAM_REMOVED_FROM_GROUP` (value: `"TEAM_REMOVED_FROM_GROUP"`) + +* `TEAM_ROLES_MODIFIED` (value: `"TEAM_ROLES_MODIFIED"`) + +* `JOINED_ORG` (value: `"JOINED_ORG"`) + +* `JOINED_TEAM` (value: `"JOINED_TEAM"`) + +* `INVITED_TO_ORG` (value: `"INVITED_TO_ORG"`) + +* `ORG_INVITATION_DELETED` (value: `"ORG_INVITATION_DELETED"`) + +* `REMOVED_FROM_ORG` (value: `"REMOVED_FROM_ORG"`) + +* `REMOVED_FROM_TEAM` (value: `"REMOVED_FROM_TEAM"`) + +* `USER_ROLES_CHANGED_AUDIT` (value: `"USER_ROLES_CHANGED_AUDIT"`) + +* `ORG_FLEX_CONSULTING_PURCHASED` (value: `"ORG_FLEX_CONSULTING_PURCHASED"`) + +* `ORG_FLEX_CONSULTING_PURCHASE_FAILED` (value: `"ORG_FLEX_CONSULTING_PURCHASE_FAILED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EventViewForNdsGroup.md b/docs/docs/EventViewForNdsGroup.md new file mode 100644 index 00000000..1b942799 --- /dev/null +++ b/docs/docs/EventViewForNdsGroup.md @@ -0,0 +1,810 @@ +# EventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**EventTypeName** | Pointer to [**UserEventTypeViewForNdsGroup**](UserEventTypeViewForNdsGroup.md) | | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the event. | [optional] [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] +**AlertId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert associated with the event. | [optional] [readonly] +**AlertConfigId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**. | [optional] [readonly] +**InvoiceId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. | [optional] [readonly] +**PaymentId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] +**Collection** | Pointer to **string** | Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`. | [optional] [readonly] +**Database** | Pointer to **string** | Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`. | [optional] [readonly] +**OpType** | Pointer to **string** | Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**CurrentValue** | Pointer to [**HostMetricValue**](HostMetricValue.md) | | [optional] +**MetricName** | Pointer to **string** | Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. | [optional] [readonly] +**WhitelistEntry** | Pointer to **string** | Entry in the list of source host addresses that the API key accepts and this event targets. | [optional] [readonly] +**EndpointId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the endpoint associated with this event. | [optional] [readonly] +**ProviderEndpointId** | Pointer to **string** | Unique identification string that the cloud provider uses to identify the private endpoint. | [optional] [readonly] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization team associated with this event. | [optional] [readonly] +**TargetUsername** | Pointer to **string** | Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`. | [optional] [readonly] + +## Methods + +### NewEventViewForNdsGroup + +`func NewEventViewForNdsGroup() *EventViewForNdsGroup` + +NewEventViewForNdsGroup instantiates a new EventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEventViewForNdsGroupWithDefaults + +`func NewEventViewForNdsGroupWithDefaults() *EventViewForNdsGroup` + +NewEventViewForNdsGroupWithDefaults instantiates a new EventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *EventViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *EventViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *EventViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *EventViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *EventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EventViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *EventViewForNdsGroup) GetEventTypeName() UserEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *EventViewForNdsGroup) GetEventTypeNameOk() (*UserEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *EventViewForNdsGroup) SetEventTypeName(v UserEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + +### HasEventTypeName + +`func (o *EventViewForNdsGroup) HasEventTypeName() bool` + +HasEventTypeName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *EventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *EventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *EventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *EventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *EventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EventViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetIsGlobalAdmin + +`func (o *EventViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *EventViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *EventViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *EventViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *EventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *EventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *EventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *EventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *EventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *EventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *EventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *EventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *EventViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *EventViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *EventViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *EventViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *EventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *EventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *EventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *EventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *EventViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *EventViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *EventViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *EventViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *EventViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *EventViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *EventViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *EventViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *EventViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *EventViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *EventViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *EventViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetAlertId + +`func (o *EventViewForNdsGroup) GetAlertId() string` + +GetAlertId returns the AlertId field if non-nil, zero value otherwise. + +### GetAlertIdOk + +`func (o *EventViewForNdsGroup) GetAlertIdOk() (*string, bool)` + +GetAlertIdOk returns a tuple with the AlertId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertId + +`func (o *EventViewForNdsGroup) SetAlertId(v string)` + +SetAlertId sets AlertId field to given value. + +### HasAlertId + +`func (o *EventViewForNdsGroup) HasAlertId() bool` + +HasAlertId returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *EventViewForNdsGroup) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *EventViewForNdsGroup) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *EventViewForNdsGroup) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + +### HasAlertConfigId + +`func (o *EventViewForNdsGroup) HasAlertConfigId() bool` + +HasAlertConfigId returns a boolean if a field has been set. + +### GetInvoiceId + +`func (o *EventViewForNdsGroup) GetInvoiceId() string` + +GetInvoiceId returns the InvoiceId field if non-nil, zero value otherwise. + +### GetInvoiceIdOk + +`func (o *EventViewForNdsGroup) GetInvoiceIdOk() (*string, bool)` + +GetInvoiceIdOk returns a tuple with the InvoiceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInvoiceId + +`func (o *EventViewForNdsGroup) SetInvoiceId(v string)` + +SetInvoiceId sets InvoiceId field to given value. + +### HasInvoiceId + +`func (o *EventViewForNdsGroup) HasInvoiceId() bool` + +HasInvoiceId returns a boolean if a field has been set. + +### GetPaymentId + +`func (o *EventViewForNdsGroup) GetPaymentId() string` + +GetPaymentId returns the PaymentId field if non-nil, zero value otherwise. + +### GetPaymentIdOk + +`func (o *EventViewForNdsGroup) GetPaymentIdOk() (*string, bool)` + +GetPaymentIdOk returns a tuple with the PaymentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPaymentId + +`func (o *EventViewForNdsGroup) SetPaymentId(v string)` + +SetPaymentId sets PaymentId field to given value. + +### HasPaymentId + +`func (o *EventViewForNdsGroup) HasPaymentId() bool` + +HasPaymentId returns a boolean if a field has been set. + +### GetShardName + +`func (o *EventViewForNdsGroup) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *EventViewForNdsGroup) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *EventViewForNdsGroup) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *EventViewForNdsGroup) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetCollection + +`func (o *EventViewForNdsGroup) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *EventViewForNdsGroup) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *EventViewForNdsGroup) SetCollection(v string)` + +SetCollection sets Collection field to given value. + +### HasCollection + +`func (o *EventViewForNdsGroup) HasCollection() bool` + +HasCollection returns a boolean if a field has been set. + +### GetDatabase + +`func (o *EventViewForNdsGroup) GetDatabase() string` + +GetDatabase returns the Database field if non-nil, zero value otherwise. + +### GetDatabaseOk + +`func (o *EventViewForNdsGroup) GetDatabaseOk() (*string, bool)` + +GetDatabaseOk returns a tuple with the Database field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabase + +`func (o *EventViewForNdsGroup) SetDatabase(v string)` + +SetDatabase sets Database field to given value. + +### HasDatabase + +`func (o *EventViewForNdsGroup) HasDatabase() bool` + +HasDatabase returns a boolean if a field has been set. + +### GetOpType + +`func (o *EventViewForNdsGroup) GetOpType() string` + +GetOpType returns the OpType field if non-nil, zero value otherwise. + +### GetOpTypeOk + +`func (o *EventViewForNdsGroup) GetOpTypeOk() (*string, bool)` + +GetOpTypeOk returns a tuple with the OpType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpType + +`func (o *EventViewForNdsGroup) SetOpType(v string)` + +SetOpType sets OpType field to given value. + +### HasOpType + +`func (o *EventViewForNdsGroup) HasOpType() bool` + +HasOpType returns a boolean if a field has been set. + +### GetPort + +`func (o *EventViewForNdsGroup) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *EventViewForNdsGroup) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *EventViewForNdsGroup) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *EventViewForNdsGroup) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *EventViewForNdsGroup) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *EventViewForNdsGroup) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *EventViewForNdsGroup) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *EventViewForNdsGroup) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetCurrentValue + +`func (o *EventViewForNdsGroup) GetCurrentValue() HostMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *EventViewForNdsGroup) GetCurrentValueOk() (*HostMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *EventViewForNdsGroup) SetCurrentValue(v HostMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *EventViewForNdsGroup) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetMetricName + +`func (o *EventViewForNdsGroup) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *EventViewForNdsGroup) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *EventViewForNdsGroup) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *EventViewForNdsGroup) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetWhitelistEntry + +`func (o *EventViewForNdsGroup) GetWhitelistEntry() string` + +GetWhitelistEntry returns the WhitelistEntry field if non-nil, zero value otherwise. + +### GetWhitelistEntryOk + +`func (o *EventViewForNdsGroup) GetWhitelistEntryOk() (*string, bool)` + +GetWhitelistEntryOk returns a tuple with the WhitelistEntry field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWhitelistEntry + +`func (o *EventViewForNdsGroup) SetWhitelistEntry(v string)` + +SetWhitelistEntry sets WhitelistEntry field to given value. + +### HasWhitelistEntry + +`func (o *EventViewForNdsGroup) HasWhitelistEntry() bool` + +HasWhitelistEntry returns a boolean if a field has been set. + +### GetEndpointId + +`func (o *EventViewForNdsGroup) GetEndpointId() string` + +GetEndpointId returns the EndpointId field if non-nil, zero value otherwise. + +### GetEndpointIdOk + +`func (o *EventViewForNdsGroup) GetEndpointIdOk() (*string, bool)` + +GetEndpointIdOk returns a tuple with the EndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointId + +`func (o *EventViewForNdsGroup) SetEndpointId(v string)` + +SetEndpointId sets EndpointId field to given value. + +### HasEndpointId + +`func (o *EventViewForNdsGroup) HasEndpointId() bool` + +HasEndpointId returns a boolean if a field has been set. + +### GetProviderEndpointId + +`func (o *EventViewForNdsGroup) GetProviderEndpointId() string` + +GetProviderEndpointId returns the ProviderEndpointId field if non-nil, zero value otherwise. + +### GetProviderEndpointIdOk + +`func (o *EventViewForNdsGroup) GetProviderEndpointIdOk() (*string, bool)` + +GetProviderEndpointIdOk returns a tuple with the ProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderEndpointId + +`func (o *EventViewForNdsGroup) SetProviderEndpointId(v string)` + +SetProviderEndpointId sets ProviderEndpointId field to given value. + +### HasProviderEndpointId + +`func (o *EventViewForNdsGroup) HasProviderEndpointId() bool` + +HasProviderEndpointId returns a boolean if a field has been set. + +### GetTeamId + +`func (o *EventViewForNdsGroup) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *EventViewForNdsGroup) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *EventViewForNdsGroup) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *EventViewForNdsGroup) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + +### GetTargetUsername + +`func (o *EventViewForNdsGroup) GetTargetUsername() string` + +GetTargetUsername returns the TargetUsername field if non-nil, zero value otherwise. + +### GetTargetUsernameOk + +`func (o *EventViewForNdsGroup) GetTargetUsernameOk() (*string, bool)` + +GetTargetUsernameOk returns a tuple with the TargetUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUsername + +`func (o *EventViewForNdsGroup) SetTargetUsername(v string)` + +SetTargetUsername sets TargetUsername field to given value. + +### HasTargetUsername + +`func (o *EventViewForNdsGroup) HasTargetUsername() bool` + +HasTargetUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EventViewForOrg.md b/docs/docs/EventViewForOrg.md new file mode 100644 index 00000000..131deeee --- /dev/null +++ b/docs/docs/EventViewForOrg.md @@ -0,0 +1,550 @@ +# EventViewForOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**EventTypeName** | Pointer to [**UserEventTypeViewForOrg**](UserEventTypeViewForOrg.md) | | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the event. | [optional] [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] +**AlertId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert associated with the event. | [optional] [readonly] +**AlertConfigId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**. | [optional] [readonly] +**InvoiceId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. | [optional] [readonly] +**PaymentId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event. | [optional] [readonly] +**WhitelistEntry** | Pointer to **string** | Entry in the list of source host addresses that the API key accepts and this event targets. | [optional] [readonly] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization team associated with this event. | [optional] [readonly] +**TargetUsername** | Pointer to **string** | Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`. | [optional] [readonly] + +## Methods + +### NewEventViewForOrg + +`func NewEventViewForOrg() *EventViewForOrg` + +NewEventViewForOrg instantiates a new EventViewForOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEventViewForOrgWithDefaults + +`func NewEventViewForOrgWithDefaults() *EventViewForOrg` + +NewEventViewForOrgWithDefaults instantiates a new EventViewForOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *EventViewForOrg) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *EventViewForOrg) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *EventViewForOrg) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *EventViewForOrg) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *EventViewForOrg) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EventViewForOrg) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EventViewForOrg) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EventViewForOrg) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *EventViewForOrg) GetEventTypeName() UserEventTypeViewForOrg` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *EventViewForOrg) GetEventTypeNameOk() (*UserEventTypeViewForOrg, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *EventViewForOrg) SetEventTypeName(v UserEventTypeViewForOrg)` + +SetEventTypeName sets EventTypeName field to given value. + +### HasEventTypeName + +`func (o *EventViewForOrg) HasEventTypeName() bool` + +HasEventTypeName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *EventViewForOrg) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *EventViewForOrg) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *EventViewForOrg) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *EventViewForOrg) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *EventViewForOrg) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EventViewForOrg) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EventViewForOrg) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EventViewForOrg) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetIsGlobalAdmin + +`func (o *EventViewForOrg) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *EventViewForOrg) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *EventViewForOrg) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *EventViewForOrg) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *EventViewForOrg) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *EventViewForOrg) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *EventViewForOrg) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *EventViewForOrg) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *EventViewForOrg) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *EventViewForOrg) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *EventViewForOrg) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *EventViewForOrg) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *EventViewForOrg) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *EventViewForOrg) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *EventViewForOrg) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *EventViewForOrg) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *EventViewForOrg) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *EventViewForOrg) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *EventViewForOrg) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *EventViewForOrg) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *EventViewForOrg) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *EventViewForOrg) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *EventViewForOrg) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *EventViewForOrg) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *EventViewForOrg) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *EventViewForOrg) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *EventViewForOrg) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *EventViewForOrg) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *EventViewForOrg) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *EventViewForOrg) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *EventViewForOrg) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *EventViewForOrg) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetAlertId + +`func (o *EventViewForOrg) GetAlertId() string` + +GetAlertId returns the AlertId field if non-nil, zero value otherwise. + +### GetAlertIdOk + +`func (o *EventViewForOrg) GetAlertIdOk() (*string, bool)` + +GetAlertIdOk returns a tuple with the AlertId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertId + +`func (o *EventViewForOrg) SetAlertId(v string)` + +SetAlertId sets AlertId field to given value. + +### HasAlertId + +`func (o *EventViewForOrg) HasAlertId() bool` + +HasAlertId returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *EventViewForOrg) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *EventViewForOrg) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *EventViewForOrg) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + +### HasAlertConfigId + +`func (o *EventViewForOrg) HasAlertConfigId() bool` + +HasAlertConfigId returns a boolean if a field has been set. + +### GetInvoiceId + +`func (o *EventViewForOrg) GetInvoiceId() string` + +GetInvoiceId returns the InvoiceId field if non-nil, zero value otherwise. + +### GetInvoiceIdOk + +`func (o *EventViewForOrg) GetInvoiceIdOk() (*string, bool)` + +GetInvoiceIdOk returns a tuple with the InvoiceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInvoiceId + +`func (o *EventViewForOrg) SetInvoiceId(v string)` + +SetInvoiceId sets InvoiceId field to given value. + +### HasInvoiceId + +`func (o *EventViewForOrg) HasInvoiceId() bool` + +HasInvoiceId returns a boolean if a field has been set. + +### GetPaymentId + +`func (o *EventViewForOrg) GetPaymentId() string` + +GetPaymentId returns the PaymentId field if non-nil, zero value otherwise. + +### GetPaymentIdOk + +`func (o *EventViewForOrg) GetPaymentIdOk() (*string, bool)` + +GetPaymentIdOk returns a tuple with the PaymentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPaymentId + +`func (o *EventViewForOrg) SetPaymentId(v string)` + +SetPaymentId sets PaymentId field to given value. + +### HasPaymentId + +`func (o *EventViewForOrg) HasPaymentId() bool` + +HasPaymentId returns a boolean if a field has been set. + +### GetWhitelistEntry + +`func (o *EventViewForOrg) GetWhitelistEntry() string` + +GetWhitelistEntry returns the WhitelistEntry field if non-nil, zero value otherwise. + +### GetWhitelistEntryOk + +`func (o *EventViewForOrg) GetWhitelistEntryOk() (*string, bool)` + +GetWhitelistEntryOk returns a tuple with the WhitelistEntry field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWhitelistEntry + +`func (o *EventViewForOrg) SetWhitelistEntry(v string)` + +SetWhitelistEntry sets WhitelistEntry field to given value. + +### HasWhitelistEntry + +`func (o *EventViewForOrg) HasWhitelistEntry() bool` + +HasWhitelistEntry returns a boolean if a field has been set. + +### GetTeamId + +`func (o *EventViewForOrg) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *EventViewForOrg) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *EventViewForOrg) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *EventViewForOrg) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + +### GetTargetUsername + +`func (o *EventViewForOrg) GetTargetUsername() string` + +GetTargetUsername returns the TargetUsername field if non-nil, zero value otherwise. + +### GetTargetUsernameOk + +`func (o *EventViewForOrg) GetTargetUsernameOk() (*string, bool)` + +GetTargetUsernameOk returns a tuple with the TargetUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUsername + +`func (o *EventViewForOrg) SetTargetUsername(v string)` + +SetTargetUsername sets TargetUsername field to given value. + +### HasTargetUsername + +`func (o *EventViewForOrg) HasTargetUsername() bool` + +HasTargetUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/EventsApi.md b/docs/docs/EventsApi.md new file mode 100644 index 00000000..78186dd9 --- /dev/null +++ b/docs/docs/EventsApi.md @@ -0,0 +1,348 @@ +# \EventsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetOrganizationEvent**](EventsApi.md#GetOrganizationEvent) | **Get** /api/atlas/v2/orgs/{orgId}/events/{eventId} | Return One Event from One Organization +[**GetProjectEvent**](EventsApi.md#GetProjectEvent) | **Get** /api/atlas/v2/groups/{groupId}/events/{eventId} | Return One Event from One Project +[**ListOrganizationEvents**](EventsApi.md#ListOrganizationEvents) | **Get** /api/atlas/v2/orgs/{orgId}/events | Return All Events from One Organization +[**ListProjectEvents**](EventsApi.md#ListProjectEvents) | **Get** /api/atlas/v2/groups/{groupId}/events | Return All Events from One Project + + + +## GetOrganizationEvent + +> EventViewForOrg GetOrganizationEvent(ctx, orgId, eventId).IncludeRaw(includeRaw).Execute() + +Return One Event from One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + eventId := "eventId_example" // string | + includeRaw := true // bool | (optional) (default to false) + + resp, r, err := sdk.EventsApi.GetOrganizationEvent(context.Background(), orgId, eventId).IncludeRaw(includeRaw).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.GetOrganizationEvent``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetOrganizationEvent`: EventViewForOrg + fmt.Fprintf(os.Stdout, "Response from `EventsApi.GetOrganizationEvent`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**eventId** | **string** | Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOrganizationEventRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeRaw** | **bool** | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. | [default to false] + +### Return type + +[**EventViewForOrg**](EventViewForOrg.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProjectEvent + +> EventViewForNdsGroup GetProjectEvent(ctx, groupId, eventId).IncludeRaw(includeRaw).Execute() + +Return One Event from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + eventId := "eventId_example" // string | + includeRaw := true // bool | (optional) (default to false) + + resp, r, err := sdk.EventsApi.GetProjectEvent(context.Background(), groupId, eventId).IncludeRaw(includeRaw).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.GetProjectEvent``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProjectEvent`: EventViewForNdsGroup + fmt.Fprintf(os.Stdout, "Response from `EventsApi.GetProjectEvent`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**eventId** | **string** | Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectEventRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeRaw** | **bool** | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. | [default to false] + +### Return type + +[**EventViewForNdsGroup**](EventViewForNdsGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListOrganizationEvents + +> OrgPaginatedEvent ListOrganizationEvents(ctx, orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).EventType(eventType).IncludeRaw(includeRaw).MaxDate(maxDate).MinDate(minDate).Execute() + +Return All Events from One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + eventType := openapiclient.EventTypeForOrg("ALERT_ACKNOWLEDGED_AUDIT") // EventTypeForOrg | (optional) + includeRaw := true // bool | (optional) (default to false) + maxDate := time.Now() // time.Time | (optional) + minDate := time.Now() // time.Time | (optional) + + resp, r, err := sdk.EventsApi.ListOrganizationEvents(context.Background(), orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).EventType(eventType).IncludeRaw(includeRaw).MaxDate(maxDate).MinDate(minDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.ListOrganizationEvents``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListOrganizationEvents`: OrgPaginatedEvent + fmt.Fprintf(os.Stdout, "Response from `EventsApi.ListOrganizationEvents`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOrganizationEventsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **eventType** | [**EventTypeForOrg**](EventTypeForOrg.md) | Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. | + **includeRaw** | **bool** | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. | [default to false] + **maxDate** | **time.Time** | Date and time from when MongoDB Cloud stops returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | + **minDate** | **time.Time** | Date and time from when MongoDB Cloud starts returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | + +### Return type + +[**OrgPaginatedEvent**](OrgPaginatedEvent.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjectEvents + +> GroupPaginatedEvent ListProjectEvents(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).ClusterNames(clusterNames).EventType(eventType).IncludeRaw(includeRaw).MaxDate(maxDate).MinDate(minDate).Execute() + +Return All Events from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + clusterNames := []string{"Inner_example"} // []string | (optional) + eventType := openapiclient.EventTypeForNdsGroup("ALERT_ACKNOWLEDGED_AUDIT") // EventTypeForNdsGroup | (optional) + includeRaw := true // bool | (optional) (default to false) + maxDate := time.Now() // time.Time | (optional) + minDate := time.Now() // time.Time | (optional) + + resp, r, err := sdk.EventsApi.ListProjectEvents(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).ClusterNames(clusterNames).EventType(eventType).IncludeRaw(includeRaw).MaxDate(maxDate).MinDate(minDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.ListProjectEvents``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjectEvents`: GroupPaginatedEvent + fmt.Fprintf(os.Stdout, "Response from `EventsApi.ListProjectEvents`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectEventsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **clusterNames** | **[]string** | Human-readable label that identifies the cluster. | + **eventType** | [**EventTypeForNdsGroup**](EventTypeForNdsGroup.md) | Category of incident recorded at this moment in time. **IMPORTANT**: The complete list of event type values changes frequently. | + **includeRaw** | **bool** | Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. | [default to false] + **maxDate** | **time.Time** | Date and time from when MongoDB Cloud stops returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | + **minDate** | **time.Time** | Date and time from when MongoDB Cloud starts returning events. This parameter uses the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | + +### Return type + +[**GroupPaginatedEvent**](GroupPaginatedEvent.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ExampleResourceResponseView20230101.md b/docs/docs/ExampleResourceResponseView20230101.md new file mode 100644 index 00000000..3c32b69c --- /dev/null +++ b/docs/docs/ExampleResourceResponseView20230101.md @@ -0,0 +1,77 @@ +# ExampleResourceResponseView20230101 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | **string** | Dummy data added as response. | +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewExampleResourceResponseView20230101 + +`func NewExampleResourceResponseView20230101(data string, ) *ExampleResourceResponseView20230101` + +NewExampleResourceResponseView20230101 instantiates a new ExampleResourceResponseView20230101 object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewExampleResourceResponseView20230101WithDefaults + +`func NewExampleResourceResponseView20230101WithDefaults() *ExampleResourceResponseView20230101` + +NewExampleResourceResponseView20230101WithDefaults instantiates a new ExampleResourceResponseView20230101 object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetData + +`func (o *ExampleResourceResponseView20230101) GetData() string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ExampleResourceResponseView20230101) GetDataOk() (*string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ExampleResourceResponseView20230101) SetData(v string)` + +SetData sets Data field to given value. + + +### GetLinks + +`func (o *ExampleResourceResponseView20230101) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ExampleResourceResponseView20230101) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ExampleResourceResponseView20230101) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ExampleResourceResponseView20230101) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ExampleResourceResponseView20230201.md b/docs/docs/ExampleResourceResponseView20230201.md new file mode 100644 index 00000000..735b09df --- /dev/null +++ b/docs/docs/ExampleResourceResponseView20230201.md @@ -0,0 +1,129 @@ +# ExampleResourceResponseView20230201 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdditionalInfo** | Pointer to **string** | Dummy additional field added to the response. | [optional] +**Data** | Pointer to **[]string** | Array that contains the dummy metadata. | [optional] +**Description** | **string** | Dummy description added as response. | +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewExampleResourceResponseView20230201 + +`func NewExampleResourceResponseView20230201(description string, ) *ExampleResourceResponseView20230201` + +NewExampleResourceResponseView20230201 instantiates a new ExampleResourceResponseView20230201 object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewExampleResourceResponseView20230201WithDefaults + +`func NewExampleResourceResponseView20230201WithDefaults() *ExampleResourceResponseView20230201` + +NewExampleResourceResponseView20230201WithDefaults instantiates a new ExampleResourceResponseView20230201 object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAdditionalInfo + +`func (o *ExampleResourceResponseView20230201) GetAdditionalInfo() string` + +GetAdditionalInfo returns the AdditionalInfo field if non-nil, zero value otherwise. + +### GetAdditionalInfoOk + +`func (o *ExampleResourceResponseView20230201) GetAdditionalInfoOk() (*string, bool)` + +GetAdditionalInfoOk returns a tuple with the AdditionalInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdditionalInfo + +`func (o *ExampleResourceResponseView20230201) SetAdditionalInfo(v string)` + +SetAdditionalInfo sets AdditionalInfo field to given value. + +### HasAdditionalInfo + +`func (o *ExampleResourceResponseView20230201) HasAdditionalInfo() bool` + +HasAdditionalInfo returns a boolean if a field has been set. + +### GetData + +`func (o *ExampleResourceResponseView20230201) GetData() []string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ExampleResourceResponseView20230201) GetDataOk() (*[]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ExampleResourceResponseView20230201) SetData(v []string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *ExampleResourceResponseView20230201) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetDescription + +`func (o *ExampleResourceResponseView20230201) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ExampleResourceResponseView20230201) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ExampleResourceResponseView20230201) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetLinks + +`func (o *ExampleResourceResponseView20230201) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ExampleResourceResponseView20230201) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ExampleResourceResponseView20230201) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ExampleResourceResponseView20230201) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ExportStatus.md b/docs/docs/ExportStatus.md new file mode 100644 index 00000000..b6729463 --- /dev/null +++ b/docs/docs/ExportStatus.md @@ -0,0 +1,82 @@ +# ExportStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExportedCollections** | Pointer to **int** | Number of collections on the replica set that MongoDB Cloud exported. | [optional] [readonly] +**TotalCollections** | Pointer to **int** | Total number of collections on the replica set to export. | [optional] [readonly] + +## Methods + +### NewExportStatus + +`func NewExportStatus() *ExportStatus` + +NewExportStatus instantiates a new ExportStatus object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewExportStatusWithDefaults + +`func NewExportStatusWithDefaults() *ExportStatus` + +NewExportStatusWithDefaults instantiates a new ExportStatus object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetExportedCollections + +`func (o *ExportStatus) GetExportedCollections() int` + +GetExportedCollections returns the ExportedCollections field if non-nil, zero value otherwise. + +### GetExportedCollectionsOk + +`func (o *ExportStatus) GetExportedCollectionsOk() (*int, bool)` + +GetExportedCollectionsOk returns a tuple with the ExportedCollections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportedCollections + +`func (o *ExportStatus) SetExportedCollections(v int)` + +SetExportedCollections sets ExportedCollections field to given value. + +### HasExportedCollections + +`func (o *ExportStatus) HasExportedCollections() bool` + +HasExportedCollections returns a boolean if a field has been set. + +### GetTotalCollections + +`func (o *ExportStatus) GetTotalCollections() int` + +GetTotalCollections returns the TotalCollections field if non-nil, zero value otherwise. + +### GetTotalCollectionsOk + +`func (o *ExportStatus) GetTotalCollectionsOk() (*int, bool)` + +GetTotalCollectionsOk returns a tuple with the TotalCollections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCollections + +`func (o *ExportStatus) SetTotalCollections(v int)` + +SetTotalCollections sets TotalCollections field to given value. + +### HasTotalCollections + +`func (o *ExportStatus) HasTotalCollections() bool` + +HasTotalCollections returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSAnalyzers.md b/docs/docs/FTSAnalyzers.md new file mode 100644 index 00000000..fc265834 --- /dev/null +++ b/docs/docs/FTSAnalyzers.md @@ -0,0 +1,124 @@ +# FTSAnalyzers + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CharFilters** | Pointer to [**[]FTSAnalyzersCharFiltersInner**](FTSAnalyzersCharFiltersInner.md) | Filters that examine text one character at a time and perform filtering operations. | [optional] +**Name** | **string** | Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings: - `lucene.` - `builtin.` - `mongodb.` | +**TokenFilters** | Pointer to [**[]FTSAnalyzersTokenFiltersInner**](FTSAnalyzersTokenFiltersInner.md) | Filter that performs operations such as: - Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\". - Redaction, the removal of sensitive information from public documents. | [optional] +**Tokenizer** | [**FTSAnalyzersTokenizer**](FTSAnalyzersTokenizer.md) | | + +## Methods + +### NewFTSAnalyzers + +`func NewFTSAnalyzers(name string, tokenizer FTSAnalyzersTokenizer, ) *FTSAnalyzers` + +NewFTSAnalyzers instantiates a new FTSAnalyzers object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSAnalyzersWithDefaults + +`func NewFTSAnalyzersWithDefaults() *FTSAnalyzers` + +NewFTSAnalyzersWithDefaults instantiates a new FTSAnalyzers object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCharFilters + +`func (o *FTSAnalyzers) GetCharFilters() []FTSAnalyzersCharFiltersInner` + +GetCharFilters returns the CharFilters field if non-nil, zero value otherwise. + +### GetCharFiltersOk + +`func (o *FTSAnalyzers) GetCharFiltersOk() (*[]FTSAnalyzersCharFiltersInner, bool)` + +GetCharFiltersOk returns a tuple with the CharFilters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCharFilters + +`func (o *FTSAnalyzers) SetCharFilters(v []FTSAnalyzersCharFiltersInner)` + +SetCharFilters sets CharFilters field to given value. + +### HasCharFilters + +`func (o *FTSAnalyzers) HasCharFilters() bool` + +HasCharFilters returns a boolean if a field has been set. + +### GetName + +`func (o *FTSAnalyzers) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FTSAnalyzers) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FTSAnalyzers) SetName(v string)` + +SetName sets Name field to given value. + + +### GetTokenFilters + +`func (o *FTSAnalyzers) GetTokenFilters() []FTSAnalyzersTokenFiltersInner` + +GetTokenFilters returns the TokenFilters field if non-nil, zero value otherwise. + +### GetTokenFiltersOk + +`func (o *FTSAnalyzers) GetTokenFiltersOk() (*[]FTSAnalyzersTokenFiltersInner, bool)` + +GetTokenFiltersOk returns a tuple with the TokenFilters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenFilters + +`func (o *FTSAnalyzers) SetTokenFilters(v []FTSAnalyzersTokenFiltersInner)` + +SetTokenFilters sets TokenFilters field to given value. + +### HasTokenFilters + +`func (o *FTSAnalyzers) HasTokenFilters() bool` + +HasTokenFilters returns a boolean if a field has been set. + +### GetTokenizer + +`func (o *FTSAnalyzers) GetTokenizer() FTSAnalyzersTokenizer` + +GetTokenizer returns the Tokenizer field if non-nil, zero value otherwise. + +### GetTokenizerOk + +`func (o *FTSAnalyzers) GetTokenizerOk() (*FTSAnalyzersTokenizer, bool)` + +GetTokenizerOk returns a tuple with the Tokenizer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokenizer + +`func (o *FTSAnalyzers) SetTokenizer(v FTSAnalyzersTokenizer)` + +SetTokenizer sets Tokenizer field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSAnalyzersCharFiltersInner.md b/docs/docs/FTSAnalyzersCharFiltersInner.md new file mode 100644 index 00000000..cac46266 --- /dev/null +++ b/docs/docs/FTSAnalyzersCharFiltersInner.md @@ -0,0 +1,98 @@ +# FTSAnalyzersCharFiltersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IgnoredTags** | Pointer to **[]string** | The HTML tags that you want to exclude from filtering. | [optional] +**Type** | **string** | Human-readable label that identifies this character filter type. | +**Mappings** | [**CharFiltermappingMappings**](CharFiltermappingMappings.md) | | + +## Methods + +### NewFTSAnalyzersCharFiltersInner + +`func NewFTSAnalyzersCharFiltersInner(type_ string, mappings CharFiltermappingMappings, ) *FTSAnalyzersCharFiltersInner` + +NewFTSAnalyzersCharFiltersInner instantiates a new FTSAnalyzersCharFiltersInner object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSAnalyzersCharFiltersInnerWithDefaults + +`func NewFTSAnalyzersCharFiltersInnerWithDefaults() *FTSAnalyzersCharFiltersInner` + +NewFTSAnalyzersCharFiltersInnerWithDefaults instantiates a new FTSAnalyzersCharFiltersInner object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIgnoredTags + +`func (o *FTSAnalyzersCharFiltersInner) GetIgnoredTags() []string` + +GetIgnoredTags returns the IgnoredTags field if non-nil, zero value otherwise. + +### GetIgnoredTagsOk + +`func (o *FTSAnalyzersCharFiltersInner) GetIgnoredTagsOk() (*[]string, bool)` + +GetIgnoredTagsOk returns a tuple with the IgnoredTags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoredTags + +`func (o *FTSAnalyzersCharFiltersInner) SetIgnoredTags(v []string)` + +SetIgnoredTags sets IgnoredTags field to given value. + +### HasIgnoredTags + +`func (o *FTSAnalyzersCharFiltersInner) HasIgnoredTags() bool` + +HasIgnoredTags returns a boolean if a field has been set. + +### GetType + +`func (o *FTSAnalyzersCharFiltersInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FTSAnalyzersCharFiltersInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FTSAnalyzersCharFiltersInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMappings + +`func (o *FTSAnalyzersCharFiltersInner) GetMappings() CharFiltermappingMappings` + +GetMappings returns the Mappings field if non-nil, zero value otherwise. + +### GetMappingsOk + +`func (o *FTSAnalyzersCharFiltersInner) GetMappingsOk() (*CharFiltermappingMappings, bool)` + +GetMappingsOk returns a tuple with the Mappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappings + +`func (o *FTSAnalyzersCharFiltersInner) SetMappings(v CharFiltermappingMappings)` + +SetMappings sets Mappings field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSAnalyzersTokenFiltersInner.md b/docs/docs/FTSAnalyzersTokenFiltersInner.md new file mode 100644 index 00000000..e8249740 --- /dev/null +++ b/docs/docs/FTSAnalyzersTokenFiltersInner.md @@ -0,0 +1,396 @@ +# FTSAnalyzersTokenFiltersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OriginalTokens** | Pointer to **string** | Value that indicates whether to include or omit the original tokens in the output of the token filter. Choose `include` if you want to support queries on both the original tokens as well as the converted forms. Choose `omit` if you want to query only on the converted forms of the original tokens. | [optional] [default to "include"] +**Type** | **string** | Human-readable label that identifies this token filter type. | +**MaxGram** | **int** | Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**. | +**MinGram** | **int** | Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**. | +**TermNotInBounds** | Pointer to **string** | Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**. | [optional] [default to "omit"] +**NormalizationForm** | Pointer to **string** | Normalization form to apply. | [optional] [default to "nfc"] +**Max** | Pointer to **int** | Number that specifies the maximum length of a token. Value must be greater than or equal to **min**. | [optional] [default to 255] +**Min** | Pointer to **int** | Number that specifies the minimum length of a token. This value must be less than or equal to **max**. | [optional] [default to 0] +**Matches** | **string** | Value that indicates whether to replace only the first matching pattern or all matching patterns. | +**Pattern** | **string** | Regular expression pattern to apply to each token. | +**Replacement** | **string** | Replacement string to substitute wherever a matching pattern occurs. | +**MaxShingleSize** | **int** | Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**. | +**MinShingleSize** | **int** | Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**. | +**StemmerName** | **string** | Snowball-generated stemmer to use. | +**IgnoreCase** | Pointer to **bool** | Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove. | [optional] [default to true] +**Tokens** | **[]string** | The stop words that correspond to the tokens to remove. Value must be one or more stop words. | + +## Methods + +### NewFTSAnalyzersTokenFiltersInner + +`func NewFTSAnalyzersTokenFiltersInner(type_ string, maxGram int, minGram int, matches string, pattern string, replacement string, maxShingleSize int, minShingleSize int, stemmerName string, tokens []string, ) *FTSAnalyzersTokenFiltersInner` + +NewFTSAnalyzersTokenFiltersInner instantiates a new FTSAnalyzersTokenFiltersInner object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSAnalyzersTokenFiltersInnerWithDefaults + +`func NewFTSAnalyzersTokenFiltersInnerWithDefaults() *FTSAnalyzersTokenFiltersInner` + +NewFTSAnalyzersTokenFiltersInnerWithDefaults instantiates a new FTSAnalyzersTokenFiltersInner object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOriginalTokens + +`func (o *FTSAnalyzersTokenFiltersInner) GetOriginalTokens() string` + +GetOriginalTokens returns the OriginalTokens field if non-nil, zero value otherwise. + +### GetOriginalTokensOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetOriginalTokensOk() (*string, bool)` + +GetOriginalTokensOk returns a tuple with the OriginalTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalTokens + +`func (o *FTSAnalyzersTokenFiltersInner) SetOriginalTokens(v string)` + +SetOriginalTokens sets OriginalTokens field to given value. + +### HasOriginalTokens + +`func (o *FTSAnalyzersTokenFiltersInner) HasOriginalTokens() bool` + +HasOriginalTokens returns a boolean if a field has been set. + +### GetType + +`func (o *FTSAnalyzersTokenFiltersInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FTSAnalyzersTokenFiltersInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMaxGram + +`func (o *FTSAnalyzersTokenFiltersInner) GetMaxGram() int` + +GetMaxGram returns the MaxGram field if non-nil, zero value otherwise. + +### GetMaxGramOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetMaxGramOk() (*int, bool)` + +GetMaxGramOk returns a tuple with the MaxGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxGram + +`func (o *FTSAnalyzersTokenFiltersInner) SetMaxGram(v int)` + +SetMaxGram sets MaxGram field to given value. + + +### GetMinGram + +`func (o *FTSAnalyzersTokenFiltersInner) GetMinGram() int` + +GetMinGram returns the MinGram field if non-nil, zero value otherwise. + +### GetMinGramOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetMinGramOk() (*int, bool)` + +GetMinGramOk returns a tuple with the MinGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinGram + +`func (o *FTSAnalyzersTokenFiltersInner) SetMinGram(v int)` + +SetMinGram sets MinGram field to given value. + + +### GetTermNotInBounds + +`func (o *FTSAnalyzersTokenFiltersInner) GetTermNotInBounds() string` + +GetTermNotInBounds returns the TermNotInBounds field if non-nil, zero value otherwise. + +### GetTermNotInBoundsOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetTermNotInBoundsOk() (*string, bool)` + +GetTermNotInBoundsOk returns a tuple with the TermNotInBounds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTermNotInBounds + +`func (o *FTSAnalyzersTokenFiltersInner) SetTermNotInBounds(v string)` + +SetTermNotInBounds sets TermNotInBounds field to given value. + +### HasTermNotInBounds + +`func (o *FTSAnalyzersTokenFiltersInner) HasTermNotInBounds() bool` + +HasTermNotInBounds returns a boolean if a field has been set. + +### GetNormalizationForm + +`func (o *FTSAnalyzersTokenFiltersInner) GetNormalizationForm() string` + +GetNormalizationForm returns the NormalizationForm field if non-nil, zero value otherwise. + +### GetNormalizationFormOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetNormalizationFormOk() (*string, bool)` + +GetNormalizationFormOk returns a tuple with the NormalizationForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNormalizationForm + +`func (o *FTSAnalyzersTokenFiltersInner) SetNormalizationForm(v string)` + +SetNormalizationForm sets NormalizationForm field to given value. + +### HasNormalizationForm + +`func (o *FTSAnalyzersTokenFiltersInner) HasNormalizationForm() bool` + +HasNormalizationForm returns a boolean if a field has been set. + +### GetMax + +`func (o *FTSAnalyzersTokenFiltersInner) GetMax() int` + +GetMax returns the Max field if non-nil, zero value otherwise. + +### GetMaxOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetMaxOk() (*int, bool)` + +GetMaxOk returns a tuple with the Max field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMax + +`func (o *FTSAnalyzersTokenFiltersInner) SetMax(v int)` + +SetMax sets Max field to given value. + +### HasMax + +`func (o *FTSAnalyzersTokenFiltersInner) HasMax() bool` + +HasMax returns a boolean if a field has been set. + +### GetMin + +`func (o *FTSAnalyzersTokenFiltersInner) GetMin() int` + +GetMin returns the Min field if non-nil, zero value otherwise. + +### GetMinOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetMinOk() (*int, bool)` + +GetMinOk returns a tuple with the Min field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMin + +`func (o *FTSAnalyzersTokenFiltersInner) SetMin(v int)` + +SetMin sets Min field to given value. + +### HasMin + +`func (o *FTSAnalyzersTokenFiltersInner) HasMin() bool` + +HasMin returns a boolean if a field has been set. + +### GetMatches + +`func (o *FTSAnalyzersTokenFiltersInner) GetMatches() string` + +GetMatches returns the Matches field if non-nil, zero value otherwise. + +### GetMatchesOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetMatchesOk() (*string, bool)` + +GetMatchesOk returns a tuple with the Matches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatches + +`func (o *FTSAnalyzersTokenFiltersInner) SetMatches(v string)` + +SetMatches sets Matches field to given value. + + +### GetPattern + +`func (o *FTSAnalyzersTokenFiltersInner) GetPattern() string` + +GetPattern returns the Pattern field if non-nil, zero value otherwise. + +### GetPatternOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetPatternOk() (*string, bool)` + +GetPatternOk returns a tuple with the Pattern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPattern + +`func (o *FTSAnalyzersTokenFiltersInner) SetPattern(v string)` + +SetPattern sets Pattern field to given value. + + +### GetReplacement + +`func (o *FTSAnalyzersTokenFiltersInner) GetReplacement() string` + +GetReplacement returns the Replacement field if non-nil, zero value otherwise. + +### GetReplacementOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetReplacementOk() (*string, bool)` + +GetReplacementOk returns a tuple with the Replacement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplacement + +`func (o *FTSAnalyzersTokenFiltersInner) SetReplacement(v string)` + +SetReplacement sets Replacement field to given value. + + +### GetMaxShingleSize + +`func (o *FTSAnalyzersTokenFiltersInner) GetMaxShingleSize() int` + +GetMaxShingleSize returns the MaxShingleSize field if non-nil, zero value otherwise. + +### GetMaxShingleSizeOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetMaxShingleSizeOk() (*int, bool)` + +GetMaxShingleSizeOk returns a tuple with the MaxShingleSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxShingleSize + +`func (o *FTSAnalyzersTokenFiltersInner) SetMaxShingleSize(v int)` + +SetMaxShingleSize sets MaxShingleSize field to given value. + + +### GetMinShingleSize + +`func (o *FTSAnalyzersTokenFiltersInner) GetMinShingleSize() int` + +GetMinShingleSize returns the MinShingleSize field if non-nil, zero value otherwise. + +### GetMinShingleSizeOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetMinShingleSizeOk() (*int, bool)` + +GetMinShingleSizeOk returns a tuple with the MinShingleSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinShingleSize + +`func (o *FTSAnalyzersTokenFiltersInner) SetMinShingleSize(v int)` + +SetMinShingleSize sets MinShingleSize field to given value. + + +### GetStemmerName + +`func (o *FTSAnalyzersTokenFiltersInner) GetStemmerName() string` + +GetStemmerName returns the StemmerName field if non-nil, zero value otherwise. + +### GetStemmerNameOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetStemmerNameOk() (*string, bool)` + +GetStemmerNameOk returns a tuple with the StemmerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStemmerName + +`func (o *FTSAnalyzersTokenFiltersInner) SetStemmerName(v string)` + +SetStemmerName sets StemmerName field to given value. + + +### GetIgnoreCase + +`func (o *FTSAnalyzersTokenFiltersInner) GetIgnoreCase() bool` + +GetIgnoreCase returns the IgnoreCase field if non-nil, zero value otherwise. + +### GetIgnoreCaseOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetIgnoreCaseOk() (*bool, bool)` + +GetIgnoreCaseOk returns a tuple with the IgnoreCase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreCase + +`func (o *FTSAnalyzersTokenFiltersInner) SetIgnoreCase(v bool)` + +SetIgnoreCase sets IgnoreCase field to given value. + +### HasIgnoreCase + +`func (o *FTSAnalyzersTokenFiltersInner) HasIgnoreCase() bool` + +HasIgnoreCase returns a boolean if a field has been set. + +### GetTokens + +`func (o *FTSAnalyzersTokenFiltersInner) GetTokens() []string` + +GetTokens returns the Tokens field if non-nil, zero value otherwise. + +### GetTokensOk + +`func (o *FTSAnalyzersTokenFiltersInner) GetTokensOk() (*[]string, bool)` + +GetTokensOk returns a tuple with the Tokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokens + +`func (o *FTSAnalyzersTokenFiltersInner) SetTokens(v []string)` + +SetTokens sets Tokens field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSAnalyzersTokenizer.md b/docs/docs/FTSAnalyzersTokenizer.md new file mode 100644 index 00000000..9246efc2 --- /dev/null +++ b/docs/docs/FTSAnalyzersTokenizer.md @@ -0,0 +1,161 @@ +# FTSAnalyzersTokenizer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxGram** | **int** | Characters to include in the longest token that Atlas Search creates. | +**MinGram** | **int** | Characters to include in the shortest token that Atlas Search creates. | +**Type** | **string** | Human-readable label that identifies this tokenizer type. | +**Group** | **int** | Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups. | +**Pattern** | **string** | Regular expression to match against. | +**MaxTokenLength** | Pointer to **int** | Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. | [optional] [default to 255] + +## Methods + +### NewFTSAnalyzersTokenizer + +`func NewFTSAnalyzersTokenizer(maxGram int, minGram int, type_ string, group int, pattern string, ) *FTSAnalyzersTokenizer` + +NewFTSAnalyzersTokenizer instantiates a new FTSAnalyzersTokenizer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSAnalyzersTokenizerWithDefaults + +`func NewFTSAnalyzersTokenizerWithDefaults() *FTSAnalyzersTokenizer` + +NewFTSAnalyzersTokenizerWithDefaults instantiates a new FTSAnalyzersTokenizer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxGram + +`func (o *FTSAnalyzersTokenizer) GetMaxGram() int` + +GetMaxGram returns the MaxGram field if non-nil, zero value otherwise. + +### GetMaxGramOk + +`func (o *FTSAnalyzersTokenizer) GetMaxGramOk() (*int, bool)` + +GetMaxGramOk returns a tuple with the MaxGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxGram + +`func (o *FTSAnalyzersTokenizer) SetMaxGram(v int)` + +SetMaxGram sets MaxGram field to given value. + + +### GetMinGram + +`func (o *FTSAnalyzersTokenizer) GetMinGram() int` + +GetMinGram returns the MinGram field if non-nil, zero value otherwise. + +### GetMinGramOk + +`func (o *FTSAnalyzersTokenizer) GetMinGramOk() (*int, bool)` + +GetMinGramOk returns a tuple with the MinGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinGram + +`func (o *FTSAnalyzersTokenizer) SetMinGram(v int)` + +SetMinGram sets MinGram field to given value. + + +### GetType + +`func (o *FTSAnalyzersTokenizer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FTSAnalyzersTokenizer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FTSAnalyzersTokenizer) SetType(v string)` + +SetType sets Type field to given value. + + +### GetGroup + +`func (o *FTSAnalyzersTokenizer) GetGroup() int` + +GetGroup returns the Group field if non-nil, zero value otherwise. + +### GetGroupOk + +`func (o *FTSAnalyzersTokenizer) GetGroupOk() (*int, bool)` + +GetGroupOk returns a tuple with the Group field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroup + +`func (o *FTSAnalyzersTokenizer) SetGroup(v int)` + +SetGroup sets Group field to given value. + + +### GetPattern + +`func (o *FTSAnalyzersTokenizer) GetPattern() string` + +GetPattern returns the Pattern field if non-nil, zero value otherwise. + +### GetPatternOk + +`func (o *FTSAnalyzersTokenizer) GetPatternOk() (*string, bool)` + +GetPatternOk returns a tuple with the Pattern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPattern + +`func (o *FTSAnalyzersTokenizer) SetPattern(v string)` + +SetPattern sets Pattern field to given value. + + +### GetMaxTokenLength + +`func (o *FTSAnalyzersTokenizer) GetMaxTokenLength() int` + +GetMaxTokenLength returns the MaxTokenLength field if non-nil, zero value otherwise. + +### GetMaxTokenLengthOk + +`func (o *FTSAnalyzersTokenizer) GetMaxTokenLengthOk() (*int, bool)` + +GetMaxTokenLengthOk returns a tuple with the MaxTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxTokenLength + +`func (o *FTSAnalyzersTokenizer) SetMaxTokenLength(v int)` + +SetMaxTokenLength sets MaxTokenLength field to given value. + +### HasMaxTokenLength + +`func (o *FTSAnalyzersTokenizer) HasMaxTokenLength() bool` + +HasMaxTokenLength returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSIndex.md b/docs/docs/FTSIndex.md new file mode 100644 index 00000000..133a9a8b --- /dev/null +++ b/docs/docs/FTSIndex.md @@ -0,0 +1,275 @@ +# FTSIndex + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Analyzer** | Pointer to **string** | Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields: - extracting words - removing punctuation - removing accents - changing to lowercase - removing common words - reducing words to their root form (stemming) - changing words to their base form (lemmatization) MongoDB Cloud uses the selected process to build the Atlas Search index. | [optional] [default to "lucene.standard"] +**Analyzers** | Pointer to [**[]FTSAnalyzers**](FTSAnalyzers.md) | List of user-defined methods to convert database field text into searchable words. | [optional] +**CollectionName** | **string** | Human-readable label that identifies the collection that contains one or more Atlas Search indexes. | +**Database** | **string** | Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. | +**IndexID** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this Atlas Search index. | [optional] [readonly] +**Mappings** | Pointer to [**FTSMappings**](FTSMappings.md) | | [optional] +**Name** | **string** | Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique. | +**SearchAnalyzer** | Pointer to **string** | Method applied to identify words when searching this index. | [optional] [default to "lucene.standard"] +**Status** | Pointer to **string** | Condition of the search index when you made this request. | Status | Index Condition | |---|---| | IN_PROGRESS | Atlas is building or re-building the index after an edit. | | STEADY | You can use this search index. | | FAILED | Atlas could not build the index. | | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. | | PAUSED | The cluster is paused. | | [optional] [readonly] +**Synonyms** | Pointer to [**[]FTSSynonymMappingDefinition**](FTSSynonymMappingDefinition.md) | Rule sets that map words to their synonyms in this index. | [optional] + +## Methods + +### NewFTSIndex + +`func NewFTSIndex(collectionName string, database string, name string, ) *FTSIndex` + +NewFTSIndex instantiates a new FTSIndex object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSIndexWithDefaults + +`func NewFTSIndexWithDefaults() *FTSIndex` + +NewFTSIndexWithDefaults instantiates a new FTSIndex object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAnalyzer + +`func (o *FTSIndex) GetAnalyzer() string` + +GetAnalyzer returns the Analyzer field if non-nil, zero value otherwise. + +### GetAnalyzerOk + +`func (o *FTSIndex) GetAnalyzerOk() (*string, bool)` + +GetAnalyzerOk returns a tuple with the Analyzer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyzer + +`func (o *FTSIndex) SetAnalyzer(v string)` + +SetAnalyzer sets Analyzer field to given value. + +### HasAnalyzer + +`func (o *FTSIndex) HasAnalyzer() bool` + +HasAnalyzer returns a boolean if a field has been set. + +### GetAnalyzers + +`func (o *FTSIndex) GetAnalyzers() []FTSAnalyzers` + +GetAnalyzers returns the Analyzers field if non-nil, zero value otherwise. + +### GetAnalyzersOk + +`func (o *FTSIndex) GetAnalyzersOk() (*[]FTSAnalyzers, bool)` + +GetAnalyzersOk returns a tuple with the Analyzers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyzers + +`func (o *FTSIndex) SetAnalyzers(v []FTSAnalyzers)` + +SetAnalyzers sets Analyzers field to given value. + +### HasAnalyzers + +`func (o *FTSIndex) HasAnalyzers() bool` + +HasAnalyzers returns a boolean if a field has been set. + +### GetCollectionName + +`func (o *FTSIndex) GetCollectionName() string` + +GetCollectionName returns the CollectionName field if non-nil, zero value otherwise. + +### GetCollectionNameOk + +`func (o *FTSIndex) GetCollectionNameOk() (*string, bool)` + +GetCollectionNameOk returns a tuple with the CollectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionName + +`func (o *FTSIndex) SetCollectionName(v string)` + +SetCollectionName sets CollectionName field to given value. + + +### GetDatabase + +`func (o *FTSIndex) GetDatabase() string` + +GetDatabase returns the Database field if non-nil, zero value otherwise. + +### GetDatabaseOk + +`func (o *FTSIndex) GetDatabaseOk() (*string, bool)` + +GetDatabaseOk returns a tuple with the Database field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabase + +`func (o *FTSIndex) SetDatabase(v string)` + +SetDatabase sets Database field to given value. + + +### GetIndexID + +`func (o *FTSIndex) GetIndexID() string` + +GetIndexID returns the IndexID field if non-nil, zero value otherwise. + +### GetIndexIDOk + +`func (o *FTSIndex) GetIndexIDOk() (*string, bool)` + +GetIndexIDOk returns a tuple with the IndexID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndexID + +`func (o *FTSIndex) SetIndexID(v string)` + +SetIndexID sets IndexID field to given value. + +### HasIndexID + +`func (o *FTSIndex) HasIndexID() bool` + +HasIndexID returns a boolean if a field has been set. + +### GetMappings + +`func (o *FTSIndex) GetMappings() FTSMappings` + +GetMappings returns the Mappings field if non-nil, zero value otherwise. + +### GetMappingsOk + +`func (o *FTSIndex) GetMappingsOk() (*FTSMappings, bool)` + +GetMappingsOk returns a tuple with the Mappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappings + +`func (o *FTSIndex) SetMappings(v FTSMappings)` + +SetMappings sets Mappings field to given value. + +### HasMappings + +`func (o *FTSIndex) HasMappings() bool` + +HasMappings returns a boolean if a field has been set. + +### GetName + +`func (o *FTSIndex) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FTSIndex) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FTSIndex) SetName(v string)` + +SetName sets Name field to given value. + + +### GetSearchAnalyzer + +`func (o *FTSIndex) GetSearchAnalyzer() string` + +GetSearchAnalyzer returns the SearchAnalyzer field if non-nil, zero value otherwise. + +### GetSearchAnalyzerOk + +`func (o *FTSIndex) GetSearchAnalyzerOk() (*string, bool)` + +GetSearchAnalyzerOk returns a tuple with the SearchAnalyzer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchAnalyzer + +`func (o *FTSIndex) SetSearchAnalyzer(v string)` + +SetSearchAnalyzer sets SearchAnalyzer field to given value. + +### HasSearchAnalyzer + +`func (o *FTSIndex) HasSearchAnalyzer() bool` + +HasSearchAnalyzer returns a boolean if a field has been set. + +### GetStatus + +`func (o *FTSIndex) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *FTSIndex) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *FTSIndex) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *FTSIndex) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSynonyms + +`func (o *FTSIndex) GetSynonyms() []FTSSynonymMappingDefinition` + +GetSynonyms returns the Synonyms field if non-nil, zero value otherwise. + +### GetSynonymsOk + +`func (o *FTSIndex) GetSynonymsOk() (*[]FTSSynonymMappingDefinition, bool)` + +GetSynonymsOk returns a tuple with the Synonyms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynonyms + +`func (o *FTSIndex) SetSynonyms(v []FTSSynonymMappingDefinition)` + +SetSynonyms sets Synonyms field to given value. + +### HasSynonyms + +`func (o *FTSIndex) HasSynonyms() bool` + +HasSynonyms returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSIndexAudit.md b/docs/docs/FTSIndexAudit.md new file mode 100644 index 00000000..bdc6c565 --- /dev/null +++ b/docs/docs/FTSIndexAudit.md @@ -0,0 +1,353 @@ +# FTSIndexAudit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**FTSIndexAuditType**](FTSIndexAuditType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewFTSIndexAudit + +`func NewFTSIndexAudit(created time.Time, eventTypeName FTSIndexAuditType, id string, ) *FTSIndexAudit` + +NewFTSIndexAudit instantiates a new FTSIndexAudit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSIndexAuditWithDefaults + +`func NewFTSIndexAuditWithDefaults() *FTSIndexAudit` + +NewFTSIndexAuditWithDefaults instantiates a new FTSIndexAudit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *FTSIndexAudit) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *FTSIndexAudit) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *FTSIndexAudit) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *FTSIndexAudit) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *FTSIndexAudit) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FTSIndexAudit) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FTSIndexAudit) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *FTSIndexAudit) GetEventTypeName() FTSIndexAuditType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *FTSIndexAudit) GetEventTypeNameOk() (*FTSIndexAuditType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *FTSIndexAudit) SetEventTypeName(v FTSIndexAuditType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *FTSIndexAudit) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *FTSIndexAudit) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *FTSIndexAudit) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *FTSIndexAudit) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *FTSIndexAudit) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FTSIndexAudit) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FTSIndexAudit) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *FTSIndexAudit) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *FTSIndexAudit) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *FTSIndexAudit) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *FTSIndexAudit) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *FTSIndexAudit) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *FTSIndexAudit) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *FTSIndexAudit) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *FTSIndexAudit) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *FTSIndexAudit) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *FTSIndexAudit) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *FTSIndexAudit) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *FTSIndexAudit) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *FTSIndexAudit) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *FTSIndexAudit) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *FTSIndexAudit) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *FTSIndexAudit) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *FTSIndexAudit) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *FTSIndexAudit) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *FTSIndexAudit) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *FTSIndexAudit) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *FTSIndexAudit) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *FTSIndexAudit) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *FTSIndexAudit) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *FTSIndexAudit) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *FTSIndexAudit) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *FTSIndexAudit) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *FTSIndexAudit) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *FTSIndexAudit) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *FTSIndexAudit) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *FTSIndexAudit) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *FTSIndexAudit) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *FTSIndexAudit) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSIndexAuditType.md b/docs/docs/FTSIndexAuditType.md new file mode 100644 index 00000000..20ab1e0d --- /dev/null +++ b/docs/docs/FTSIndexAuditType.md @@ -0,0 +1,21 @@ +# FTSIndexAuditType + +## Enum + + +* `DELETION_FAILED` (value: `"FTS_INDEX_DELETION_FAILED"`) + +* `BUILD_COMPLETE` (value: `"FTS_INDEX_BUILD_COMPLETE"`) + +* `BUILD_FAILED` (value: `"FTS_INDEX_BUILD_FAILED"`) + +* `CREATED` (value: `"FTS_INDEX_CREATED"`) + +* `UPDATED` (value: `"FTS_INDEX_UPDATED"`) + +* `DELETED` (value: `"FTS_INDEX_DELETED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSMappings.md b/docs/docs/FTSMappings.md new file mode 100644 index 00000000..57258a47 --- /dev/null +++ b/docs/docs/FTSMappings.md @@ -0,0 +1,82 @@ +# FTSMappings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Dynamic** | Pointer to **bool** | Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted. | [optional] [default to false] +**Fields** | Pointer to **map[string]map[string]interface{}** | One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**. | [optional] + +## Methods + +### NewFTSMappings + +`func NewFTSMappings() *FTSMappings` + +NewFTSMappings instantiates a new FTSMappings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSMappingsWithDefaults + +`func NewFTSMappingsWithDefaults() *FTSMappings` + +NewFTSMappingsWithDefaults instantiates a new FTSMappings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDynamic + +`func (o *FTSMappings) GetDynamic() bool` + +GetDynamic returns the Dynamic field if non-nil, zero value otherwise. + +### GetDynamicOk + +`func (o *FTSMappings) GetDynamicOk() (*bool, bool)` + +GetDynamicOk returns a tuple with the Dynamic field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDynamic + +`func (o *FTSMappings) SetDynamic(v bool)` + +SetDynamic sets Dynamic field to given value. + +### HasDynamic + +`func (o *FTSMappings) HasDynamic() bool` + +HasDynamic returns a boolean if a field has been set. + +### GetFields + +`func (o *FTSMappings) GetFields() map[string]map[string]interface{}` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *FTSMappings) GetFieldsOk() (*map[string]map[string]interface{}, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *FTSMappings) SetFields(v map[string]map[string]interface{})` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *FTSMappings) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSMetric.md b/docs/docs/FTSMetric.md new file mode 100644 index 00000000..c0255de0 --- /dev/null +++ b/docs/docs/FTSMetric.md @@ -0,0 +1,72 @@ +# FTSMetric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | **string** | Human-readable label that identifies this Atlas Search hardware, status, or index measurement. | [readonly] +**Units** | **string** | Unit of measurement that applies to this Atlas Search metric. | [readonly] + +## Methods + +### NewFTSMetric + +`func NewFTSMetric(metricName string, units string, ) *FTSMetric` + +NewFTSMetric instantiates a new FTSMetric object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSMetricWithDefaults + +`func NewFTSMetricWithDefaults() *FTSMetric` + +NewFTSMetricWithDefaults instantiates a new FTSMetric object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *FTSMetric) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *FTSMetric) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *FTSMetric) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + + +### GetUnits + +`func (o *FTSMetric) GetUnits() string` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *FTSMetric) GetUnitsOk() (*string, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *FTSMetric) SetUnits(v string)` + +SetUnits sets Units field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSMetrics.md b/docs/docs/FTSMetrics.md new file mode 100644 index 00000000..8ac13167 --- /dev/null +++ b/docs/docs/FTSMetrics.md @@ -0,0 +1,176 @@ +# FTSMetrics + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**GroupId** | **string** | Unique 24-hexadecimal digit string that identifies the project. | [readonly] +**HardwareMetrics** | Pointer to [**[]FTSMetric**](FTSMetric.md) | List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request. | [optional] [readonly] +**IndexMetrics** | Pointer to [**[]FTSMetric**](FTSMetric.md) | List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**ProcessId** | **string** | Hostname and port that identifies the process. | [readonly] +**StatusMetrics** | Pointer to [**[]FTSMetric**](FTSMetric.md) | List that contains all available Atlas Search status metrics when MongoDB Atlas received this request. | [optional] [readonly] + +## Methods + +### NewFTSMetrics + +`func NewFTSMetrics(groupId string, processId string, ) *FTSMetrics` + +NewFTSMetrics instantiates a new FTSMetrics object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSMetricsWithDefaults + +`func NewFTSMetricsWithDefaults() *FTSMetrics` + +NewFTSMetricsWithDefaults instantiates a new FTSMetrics object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetGroupId + +`func (o *FTSMetrics) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *FTSMetrics) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *FTSMetrics) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + + +### GetHardwareMetrics + +`func (o *FTSMetrics) GetHardwareMetrics() []FTSMetric` + +GetHardwareMetrics returns the HardwareMetrics field if non-nil, zero value otherwise. + +### GetHardwareMetricsOk + +`func (o *FTSMetrics) GetHardwareMetricsOk() (*[]FTSMetric, bool)` + +GetHardwareMetricsOk returns a tuple with the HardwareMetrics field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHardwareMetrics + +`func (o *FTSMetrics) SetHardwareMetrics(v []FTSMetric)` + +SetHardwareMetrics sets HardwareMetrics field to given value. + +### HasHardwareMetrics + +`func (o *FTSMetrics) HasHardwareMetrics() bool` + +HasHardwareMetrics returns a boolean if a field has been set. + +### GetIndexMetrics + +`func (o *FTSMetrics) GetIndexMetrics() []FTSMetric` + +GetIndexMetrics returns the IndexMetrics field if non-nil, zero value otherwise. + +### GetIndexMetricsOk + +`func (o *FTSMetrics) GetIndexMetricsOk() (*[]FTSMetric, bool)` + +GetIndexMetricsOk returns a tuple with the IndexMetrics field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndexMetrics + +`func (o *FTSMetrics) SetIndexMetrics(v []FTSMetric)` + +SetIndexMetrics sets IndexMetrics field to given value. + +### HasIndexMetrics + +`func (o *FTSMetrics) HasIndexMetrics() bool` + +HasIndexMetrics returns a boolean if a field has been set. + +### GetLinks + +`func (o *FTSMetrics) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *FTSMetrics) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *FTSMetrics) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *FTSMetrics) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetProcessId + +`func (o *FTSMetrics) GetProcessId() string` + +GetProcessId returns the ProcessId field if non-nil, zero value otherwise. + +### GetProcessIdOk + +`func (o *FTSMetrics) GetProcessIdOk() (*string, bool)` + +GetProcessIdOk returns a tuple with the ProcessId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessId + +`func (o *FTSMetrics) SetProcessId(v string)` + +SetProcessId sets ProcessId field to given value. + + +### GetStatusMetrics + +`func (o *FTSMetrics) GetStatusMetrics() []FTSMetric` + +GetStatusMetrics returns the StatusMetrics field if non-nil, zero value otherwise. + +### GetStatusMetricsOk + +`func (o *FTSMetrics) GetStatusMetricsOk() (*[]FTSMetric, bool)` + +GetStatusMetricsOk returns a tuple with the StatusMetrics field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusMetrics + +`func (o *FTSMetrics) SetStatusMetrics(v []FTSMetric)` + +SetStatusMetrics sets StatusMetrics field to given value. + +### HasStatusMetrics + +`func (o *FTSMetrics) HasStatusMetrics() bool` + +HasStatusMetrics returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FTSSynonymMappingDefinition.md b/docs/docs/FTSSynonymMappingDefinition.md new file mode 100644 index 00000000..17c7201a --- /dev/null +++ b/docs/docs/FTSSynonymMappingDefinition.md @@ -0,0 +1,93 @@ +# FTSSynonymMappingDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Analyzer** | **string** | Specific pre-defined method chosen to apply to the synonyms to be searched. | [default to "lucene.standard"] +**Name** | **string** | Human-readable label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition. | +**Source** | [**SynonymSource**](SynonymSource.md) | | + +## Methods + +### NewFTSSynonymMappingDefinition + +`func NewFTSSynonymMappingDefinition(analyzer string, name string, source SynonymSource, ) *FTSSynonymMappingDefinition` + +NewFTSSynonymMappingDefinition instantiates a new FTSSynonymMappingDefinition object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFTSSynonymMappingDefinitionWithDefaults + +`func NewFTSSynonymMappingDefinitionWithDefaults() *FTSSynonymMappingDefinition` + +NewFTSSynonymMappingDefinitionWithDefaults instantiates a new FTSSynonymMappingDefinition object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAnalyzer + +`func (o *FTSSynonymMappingDefinition) GetAnalyzer() string` + +GetAnalyzer returns the Analyzer field if non-nil, zero value otherwise. + +### GetAnalyzerOk + +`func (o *FTSSynonymMappingDefinition) GetAnalyzerOk() (*string, bool)` + +GetAnalyzerOk returns a tuple with the Analyzer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyzer + +`func (o *FTSSynonymMappingDefinition) SetAnalyzer(v string)` + +SetAnalyzer sets Analyzer field to given value. + + +### GetName + +`func (o *FTSSynonymMappingDefinition) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FTSSynonymMappingDefinition) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FTSSynonymMappingDefinition) SetName(v string)` + +SetName sets Name field to given value. + + +### GetSource + +`func (o *FTSSynonymMappingDefinition) GetSource() SynonymSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *FTSSynonymMappingDefinition) GetSourceOk() (*SynonymSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *FTSSynonymMappingDefinition) SetSource(v SynonymSource)` + +SetSource sets Source field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FederatedAuthenticationApi.md b/docs/docs/FederatedAuthenticationApi.md new file mode 100644 index 00000000..e0999d76 --- /dev/null +++ b/docs/docs/FederatedAuthenticationApi.md @@ -0,0 +1,1177 @@ +# \FederatedAuthenticationApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateRoleMapping**](FederatedAuthenticationApi.md#CreateRoleMapping) | **Post** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings | Add One Role Mapping to One Organization +[**DeleteFederationApp**](FederatedAuthenticationApi.md#DeleteFederationApp) | **Delete** /api/atlas/v2/federationSettings/{federationSettingsId} | Delete the federation settings instance. +[**DeleteRoleMapping**](FederatedAuthenticationApi.md#DeleteRoleMapping) | **Delete** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id} | Remove One Role Mapping from One Organization +[**GetConnectedOrgConfig**](FederatedAuthenticationApi.md#GetConnectedOrgConfig) | **Get** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} | Return One Org Config Connected to One Federation +[**GetFederationSettings**](FederatedAuthenticationApi.md#GetFederationSettings) | **Get** /api/atlas/v2/orgs/{orgId}/federationSettings | Return Federation Settings for One Organization +[**GetIdentityProvider**](FederatedAuthenticationApi.md#GetIdentityProvider) | **Get** /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} | Return one identity provider from the specified federation. +[**GetIdentityProviderMetadata**](FederatedAuthenticationApi.md#GetIdentityProviderMetadata) | **Get** /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml | Return the metadata of one identity provider in the specified federation. +[**GetRoleMapping**](FederatedAuthenticationApi.md#GetRoleMapping) | **Get** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id} | Return One Role Mapping from One Organization +[**ListConnectedOrgConfigs**](FederatedAuthenticationApi.md#ListConnectedOrgConfigs) | **Get** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs | Return All Connected Org Configs from the Federation +[**ListIdentityProviders**](FederatedAuthenticationApi.md#ListIdentityProviders) | **Get** /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders | Return all identity providers from the specified federation. +[**ListRoleMappings**](FederatedAuthenticationApi.md#ListRoleMappings) | **Get** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings | Return All Role Mappings from One Organization +[**RemoveConnectedOrgConfig**](FederatedAuthenticationApi.md#RemoveConnectedOrgConfig) | **Delete** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} | Remove One Org Config Connected to One Federation +[**UpdateConnectedOrgConfig**](FederatedAuthenticationApi.md#UpdateConnectedOrgConfig) | **Patch** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} | Update One Org Config Connected to One Federation +[**UpdateIdentityProvider**](FederatedAuthenticationApi.md#UpdateIdentityProvider) | **Patch** /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} | Update the identity provider. +[**UpdateRoleMapping**](FederatedAuthenticationApi.md#UpdateRoleMapping) | **Put** /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id} | Update One Role Mapping in One Organization + + + +## CreateRoleMapping + +> RoleMapping CreateRoleMapping(ctx, federationSettingsId, orgId).RoleMapping(roleMapping).Execute() + +Add One Role Mapping to One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + orgId := "4888442a3354817a7320eb61" // string | + roleMapping := *openapiclient.NewRoleMapping("ExternalGroupName_example") // RoleMapping | + + resp, r, err := sdk.FederatedAuthenticationApi.CreateRoleMapping(context.Background(), federationSettingsId, orgId).RoleMapping(roleMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.CreateRoleMapping``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateRoleMapping`: RoleMapping + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.CreateRoleMapping`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **roleMapping** | [**RoleMapping**](RoleMapping.md) | The role mapping that you want to create. | + +### Return type + +[**RoleMapping**](RoleMapping.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteFederationApp + +> DeleteFederationApp(ctx, federationSettingsId).Execute() + +Delete the federation settings instance. + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + + r, err := sdk.FederatedAuthenticationApi.DeleteFederationApp(context.Background(), federationSettingsId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.DeleteFederationApp``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteFederationAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteRoleMapping + +> DeleteRoleMapping(ctx, federationSettingsId, id, orgId).Execute() + +Remove One Role Mapping from One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + id := "32b6e34b3d91647abb20e7b8" // string | + orgId := "4888442a3354817a7320eb61" // string | + + r, err := sdk.FederatedAuthenticationApi.DeleteRoleMapping(context.Background(), federationSettingsId, id, orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.DeleteRoleMapping``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**id** | **string** | Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteRoleMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetConnectedOrgConfig + +> ConnectedOrgConfig GetConnectedOrgConfig(ctx, federationSettingsId, orgId).Execute() + +Return One Org Config Connected to One Federation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + orgId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.GetConnectedOrgConfig(context.Background(), federationSettingsId, orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.GetConnectedOrgConfig``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetConnectedOrgConfig`: ConnectedOrgConfig + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.GetConnectedOrgConfig`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the connected organization configuration to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectedOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ConnectedOrgConfig**](ConnectedOrgConfig.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetFederationSettings + +> OrgFederationSettings GetFederationSettings(ctx, orgId).Execute() + +Return Federation Settings for One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.GetFederationSettings(context.Background(), orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.GetFederationSettings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetFederationSettings`: OrgFederationSettings + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.GetFederationSettings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFederationSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**OrgFederationSettings**](OrgFederationSettings.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetIdentityProvider + +> IdentityProvider GetIdentityProvider(ctx, federationSettingsId, identityProviderId).Execute() + +Return one identity provider from the specified federation. + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + identityProviderId := "c2777a9eca931f29fc2f" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.GetIdentityProvider(context.Background(), federationSettingsId, identityProviderId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.GetIdentityProvider``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetIdentityProvider`: IdentityProvider + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.GetIdentityProvider`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**identityProviderId** | **string** | Unique 20-hexadecimal digit string that identifies the identity provider. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityProviderRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**IdentityProvider**](IdentityProvider.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetIdentityProviderMetadata + +> string GetIdentityProviderMetadata(ctx, federationSettingsId, identityProviderId).Execute() + +Return the metadata of one identity provider in the specified federation. + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + identityProviderId := "c2777a9eca931f29fc2f" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.GetIdentityProviderMetadata(context.Background(), federationSettingsId, identityProviderId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.GetIdentityProviderMetadata``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetIdentityProviderMetadata`: string + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.GetIdentityProviderMetadata`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**identityProviderId** | **string** | Unique 20-hexadecimal digit string that identifies the identity provider. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityProviderMetadataRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**string** + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetRoleMapping + +> RoleMapping GetRoleMapping(ctx, federationSettingsId, id, orgId).Execute() + +Return One Role Mapping from One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + id := "32b6e34b3d91647abb20e7b8" // string | + orgId := "4888442a3354817a7320eb61" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.GetRoleMapping(context.Background(), federationSettingsId, id, orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.GetRoleMapping``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetRoleMapping`: RoleMapping + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.GetRoleMapping`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**id** | **string** | Unique 24-hexadecimal digit string that identifies the role mapping that you want to return. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**RoleMapping**](RoleMapping.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListConnectedOrgConfigs + +> []ConnectedOrgConfig ListConnectedOrgConfigs(ctx, federationSettingsId).Execute() + +Return All Connected Org Configs from the Federation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.ListConnectedOrgConfigs(context.Background(), federationSettingsId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.ListConnectedOrgConfigs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListConnectedOrgConfigs`: []ConnectedOrgConfig + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.ListConnectedOrgConfigs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListConnectedOrgConfigsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ConnectedOrgConfig**](ConnectedOrgConfig.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListIdentityProviders + +> []IdentityProvider ListIdentityProviders(ctx, federationSettingsId).Execute() + +Return all identity providers from the specified federation. + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.ListIdentityProviders(context.Background(), federationSettingsId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.ListIdentityProviders``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListIdentityProviders`: []IdentityProvider + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.ListIdentityProviders`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityProvidersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]IdentityProvider**](IdentityProvider.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListRoleMappings + +> []RoleMapping ListRoleMappings(ctx, federationSettingsId, orgId).Execute() + +Return All Role Mappings from One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + orgId := "4888442a3354817a7320eb61" // string | + + resp, r, err := sdk.FederatedAuthenticationApi.ListRoleMappings(context.Background(), federationSettingsId, orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.ListRoleMappings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListRoleMappings`: []RoleMapping + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.ListRoleMappings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRoleMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**[]RoleMapping**](RoleMapping.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RemoveConnectedOrgConfig + +> RemoveConnectedOrgConfig(ctx, federationSettingsId, orgId).Execute() + +Remove One Org Config Connected to One Federation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + orgId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.FederatedAuthenticationApi.RemoveConnectedOrgConfig(context.Background(), federationSettingsId, orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.RemoveConnectedOrgConfig``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRemoveConnectedOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateConnectedOrgConfig + +> ConnectedOrgConfig UpdateConnectedOrgConfig(ctx, federationSettingsId, orgId).ConnectedOrgConfig(connectedOrgConfig).Execute() + +Update One Org Config Connected to One Federation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + orgId := "32b6e34b3d91647abb20e7b8" // string | + connectedOrgConfig := *openapiclient.NewConnectedOrgConfig(false, "IdentityProviderId_example", "32b6e34b3d91647abb20e7b8") // ConnectedOrgConfig | + + resp, r, err := sdk.FederatedAuthenticationApi.UpdateConnectedOrgConfig(context.Background(), federationSettingsId, orgId).ConnectedOrgConfig(connectedOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.UpdateConnectedOrgConfig``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateConnectedOrgConfig`: ConnectedOrgConfig + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.UpdateConnectedOrgConfig`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the connected organization configuration to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateConnectedOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **connectedOrgConfig** | [**ConnectedOrgConfig**](ConnectedOrgConfig.md) | The connected organization configuration that you want to update. | + +### Return type + +[**ConnectedOrgConfig**](ConnectedOrgConfig.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateIdentityProvider + +> IdentityProvider UpdateIdentityProvider(ctx, federationSettingsId, identityProviderId).IdentityProviderUpdate(identityProviderUpdate).Execute() + +Update the identity provider. + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + identityProviderId := "c2777a9eca931f29fc2f" // string | + identityProviderUpdate := *openapiclient.NewIdentityProviderUpdate(false) // IdentityProviderUpdate | + + resp, r, err := sdk.FederatedAuthenticationApi.UpdateIdentityProvider(context.Background(), federationSettingsId, identityProviderId).IdentityProviderUpdate(identityProviderUpdate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.UpdateIdentityProvider``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateIdentityProvider`: IdentityProvider + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.UpdateIdentityProvider`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**identityProviderId** | **string** | Unique 20-hexadecimal digit string that identifies the identity provider. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateIdentityProviderRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **identityProviderUpdate** | [**IdentityProviderUpdate**](IdentityProviderUpdate.md) | The identity provider that you want to update. | + +### Return type + +[**IdentityProvider**](IdentityProvider.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateRoleMapping + +> RoleMapping UpdateRoleMapping(ctx, federationSettingsId, id, orgId).RoleMapping(roleMapping).Execute() + +Update One Role Mapping in One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + federationSettingsId := "55fa922fb343282757d9554e" // string | + id := "32b6e34b3d91647abb20e7b8" // string | + orgId := "4888442a3354817a7320eb61" // string | + roleMapping := *openapiclient.NewRoleMapping("ExternalGroupName_example") // RoleMapping | + + resp, r, err := sdk.FederatedAuthenticationApi.UpdateRoleMapping(context.Background(), federationSettingsId, id, orgId).RoleMapping(roleMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `FederatedAuthenticationApi.UpdateRoleMapping``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateRoleMapping`: RoleMapping + fmt.Fprintf(os.Stdout, "Response from `FederatedAuthenticationApi.UpdateRoleMapping`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**federationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies your federation. | +**id** | **string** | Unique 24-hexadecimal digit string that identifies the role mapping that you want to update. | +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRoleMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **roleMapping** | [**RoleMapping**](RoleMapping.md) | The role mapping that you want to update. | + +### Return type + +[**RoleMapping**](RoleMapping.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/FederatedUser.md b/docs/docs/FederatedUser.md new file mode 100644 index 00000000..7e6a5c97 --- /dev/null +++ b/docs/docs/FederatedUser.md @@ -0,0 +1,140 @@ +# FederatedUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EmailAddress** | **string** | Email address of the MongoDB Cloud user linked to the federated organization. | +**FederationSettingsId** | **string** | Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs. | +**FirstName** | **string** | First or given name that belongs to the MongoDB Cloud user. | +**LastName** | **string** | Last name, family name, or surname that belongs to the MongoDB Cloud user. | +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this user. | [optional] [readonly] + +## Methods + +### NewFederatedUser + +`func NewFederatedUser(emailAddress string, federationSettingsId string, firstName string, lastName string, ) *FederatedUser` + +NewFederatedUser instantiates a new FederatedUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFederatedUserWithDefaults + +`func NewFederatedUserWithDefaults() *FederatedUser` + +NewFederatedUserWithDefaults instantiates a new FederatedUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEmailAddress + +`func (o *FederatedUser) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *FederatedUser) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *FederatedUser) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + + +### GetFederationSettingsId + +`func (o *FederatedUser) GetFederationSettingsId() string` + +GetFederationSettingsId returns the FederationSettingsId field if non-nil, zero value otherwise. + +### GetFederationSettingsIdOk + +`func (o *FederatedUser) GetFederationSettingsIdOk() (*string, bool)` + +GetFederationSettingsIdOk returns a tuple with the FederationSettingsId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationSettingsId + +`func (o *FederatedUser) SetFederationSettingsId(v string)` + +SetFederationSettingsId sets FederationSettingsId field to given value. + + +### GetFirstName + +`func (o *FederatedUser) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *FederatedUser) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *FederatedUser) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + + +### GetLastName + +`func (o *FederatedUser) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *FederatedUser) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *FederatedUser) SetLastName(v string)` + +SetLastName sets LastName field to given value. + + +### GetUserId + +`func (o *FederatedUser) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *FederatedUser) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *FederatedUser) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *FederatedUser) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FieldTransformation.md b/docs/docs/FieldTransformation.md new file mode 100644 index 00000000..caa66d5f --- /dev/null +++ b/docs/docs/FieldTransformation.md @@ -0,0 +1,82 @@ +# FieldTransformation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | Pointer to **string** | Key in the document. | [optional] +**Type** | Pointer to **string** | Type of transformation applied during the export of the namespace in a Data Lake Pipeline. | [optional] + +## Methods + +### NewFieldTransformation + +`func NewFieldTransformation() *FieldTransformation` + +NewFieldTransformation instantiates a new FieldTransformation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFieldTransformationWithDefaults + +`func NewFieldTransformationWithDefaults() *FieldTransformation` + +NewFieldTransformationWithDefaults instantiates a new FieldTransformation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetField + +`func (o *FieldTransformation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *FieldTransformation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *FieldTransformation) SetField(v string)` + +SetField sets Field field to given value. + +### HasField + +`func (o *FieldTransformation) HasField() bool` + +HasField returns a boolean if a field has been set. + +### GetType + +`func (o *FieldTransformation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FieldTransformation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FieldTransformation) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FieldTransformation) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ForNdsGroup.md b/docs/docs/ForNdsGroup.md new file mode 100644 index 00000000..96a03de1 --- /dev/null +++ b/docs/docs/ForNdsGroup.md @@ -0,0 +1,275 @@ +# ForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**ReplicaSetEventTypeViewForNdsGroup**](ReplicaSetEventTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] + +## Methods + +### NewForNdsGroup + +`func NewForNdsGroup(created time.Time, eventTypeName ReplicaSetEventTypeViewForNdsGroup, id string, ) *ForNdsGroup` + +NewForNdsGroup instantiates a new ForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewForNdsGroupWithDefaults + +`func NewForNdsGroupWithDefaults() *ForNdsGroup` + +NewForNdsGroupWithDefaults instantiates a new ForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *ForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *ForNdsGroup) GetEventTypeName() ReplicaSetEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ForNdsGroup) GetEventTypeNameOk() (*ReplicaSetEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ForNdsGroup) SetEventTypeName(v ReplicaSetEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLinks + +`func (o *ForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *ForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *ForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPort + +`func (o *ForNdsGroup) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *ForNdsGroup) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *ForNdsGroup) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *ForNdsGroup) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetRaw + +`func (o *ForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *ForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *ForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *ForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *ForNdsGroup) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *ForNdsGroup) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *ForNdsGroup) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *ForNdsGroup) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *ForNdsGroup) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *ForNdsGroup) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *ForNdsGroup) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *ForNdsGroup) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FreeAutoScaling.md b/docs/docs/FreeAutoScaling.md new file mode 100644 index 00000000..87f5ecce --- /dev/null +++ b/docs/docs/FreeAutoScaling.md @@ -0,0 +1,56 @@ +# FreeAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Compute** | Pointer to **string** | Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. | [optional] + +## Methods + +### NewFreeAutoScaling + +`func NewFreeAutoScaling() *FreeAutoScaling` + +NewFreeAutoScaling instantiates a new FreeAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFreeAutoScalingWithDefaults + +`func NewFreeAutoScalingWithDefaults() *FreeAutoScaling` + +NewFreeAutoScalingWithDefaults instantiates a new FreeAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCompute + +`func (o *FreeAutoScaling) GetCompute() string` + +GetCompute returns the Compute field if non-nil, zero value otherwise. + +### GetComputeOk + +`func (o *FreeAutoScaling) GetComputeOk() (*string, bool)` + +GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompute + +`func (o *FreeAutoScaling) SetCompute(v string)` + +SetCompute sets Compute field to given value. + +### HasCompute + +`func (o *FreeAutoScaling) HasCompute() bool` + +HasCompute returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/FreeProviderSettings.md b/docs/docs/FreeProviderSettings.md new file mode 100644 index 00000000..e0211fe7 --- /dev/null +++ b/docs/docs/FreeProviderSettings.md @@ -0,0 +1,155 @@ +# FreeProviderSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoScaling** | Pointer to [**FreeAutoScaling**](FreeAutoScaling.md) | | [optional] +**BackingProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M2` or `M5`. | [optional] +**InstanceSizeName** | Pointer to **string** | Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**. | [optional] +**RegionName** | Pointer to **string** | Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**. | [optional] +**ProviderName** | **string** | | + +## Methods + +### NewFreeProviderSettings + +`func NewFreeProviderSettings(providerName string, ) *FreeProviderSettings` + +NewFreeProviderSettings instantiates a new FreeProviderSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFreeProviderSettingsWithDefaults + +`func NewFreeProviderSettingsWithDefaults() *FreeProviderSettings` + +NewFreeProviderSettingsWithDefaults instantiates a new FreeProviderSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoScaling + +`func (o *FreeProviderSettings) GetAutoScaling() FreeAutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *FreeProviderSettings) GetAutoScalingOk() (*FreeAutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *FreeProviderSettings) SetAutoScaling(v FreeAutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *FreeProviderSettings) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetBackingProviderName + +`func (o *FreeProviderSettings) GetBackingProviderName() string` + +GetBackingProviderName returns the BackingProviderName field if non-nil, zero value otherwise. + +### GetBackingProviderNameOk + +`func (o *FreeProviderSettings) GetBackingProviderNameOk() (*string, bool)` + +GetBackingProviderNameOk returns a tuple with the BackingProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackingProviderName + +`func (o *FreeProviderSettings) SetBackingProviderName(v string)` + +SetBackingProviderName sets BackingProviderName field to given value. + +### HasBackingProviderName + +`func (o *FreeProviderSettings) HasBackingProviderName() bool` + +HasBackingProviderName returns a boolean if a field has been set. + +### GetInstanceSizeName + +`func (o *FreeProviderSettings) GetInstanceSizeName() string` + +GetInstanceSizeName returns the InstanceSizeName field if non-nil, zero value otherwise. + +### GetInstanceSizeNameOk + +`func (o *FreeProviderSettings) GetInstanceSizeNameOk() (*string, bool)` + +GetInstanceSizeNameOk returns a tuple with the InstanceSizeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSizeName + +`func (o *FreeProviderSettings) SetInstanceSizeName(v string)` + +SetInstanceSizeName sets InstanceSizeName field to given value. + +### HasInstanceSizeName + +`func (o *FreeProviderSettings) HasInstanceSizeName() bool` + +HasInstanceSizeName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *FreeProviderSettings) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *FreeProviderSettings) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *FreeProviderSettings) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *FreeProviderSettings) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetProviderName + +`func (o *FreeProviderSettings) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *FreeProviderSettings) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *FreeProviderSettings) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPAutoScaling.md b/docs/docs/GCPAutoScaling.md new file mode 100644 index 00000000..1f5bc6c3 --- /dev/null +++ b/docs/docs/GCPAutoScaling.md @@ -0,0 +1,56 @@ +# GCPAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Compute** | Pointer to [**GCPComputeAutoScaling**](GCPComputeAutoScaling.md) | | [optional] + +## Methods + +### NewGCPAutoScaling + +`func NewGCPAutoScaling() *GCPAutoScaling` + +NewGCPAutoScaling instantiates a new GCPAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPAutoScalingWithDefaults + +`func NewGCPAutoScalingWithDefaults() *GCPAutoScaling` + +NewGCPAutoScalingWithDefaults instantiates a new GCPAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCompute + +`func (o *GCPAutoScaling) GetCompute() GCPComputeAutoScaling` + +GetCompute returns the Compute field if non-nil, zero value otherwise. + +### GetComputeOk + +`func (o *GCPAutoScaling) GetComputeOk() (*GCPComputeAutoScaling, bool)` + +GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompute + +`func (o *GCPAutoScaling) SetCompute(v GCPComputeAutoScaling)` + +SetCompute sets Compute field to given value. + +### HasCompute + +`func (o *GCPAutoScaling) HasCompute() bool` + +HasCompute returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPCloudProviderContainer.md b/docs/docs/GCPCloudProviderContainer.md new file mode 100644 index 00000000..3f3082ec --- /dev/null +++ b/docs/docs/GCPCloudProviderContainer.md @@ -0,0 +1,207 @@ +# GCPCloudProviderContainer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AtlasCidrBlock** | **string** | IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. To modify the CIDR block, the target project cannot have: - Any M10 or greater clusters - Any other VPC peering connections You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. | +**GcpProjectId** | Pointer to **string** | Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container. | [optional] [readonly] +**NetworkName** | Pointer to **string** | Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container. | [optional] [readonly] +**Regions** | Pointer to **[]string** | List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects. | [optional] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering container. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering containers. | [optional] +**Provisioned** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. | [optional] [readonly] + +## Methods + +### NewGCPCloudProviderContainer + +`func NewGCPCloudProviderContainer(atlasCidrBlock string, ) *GCPCloudProviderContainer` + +NewGCPCloudProviderContainer instantiates a new GCPCloudProviderContainer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPCloudProviderContainerWithDefaults + +`func NewGCPCloudProviderContainerWithDefaults() *GCPCloudProviderContainer` + +NewGCPCloudProviderContainerWithDefaults instantiates a new GCPCloudProviderContainer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAtlasCidrBlock + +`func (o *GCPCloudProviderContainer) GetAtlasCidrBlock() string` + +GetAtlasCidrBlock returns the AtlasCidrBlock field if non-nil, zero value otherwise. + +### GetAtlasCidrBlockOk + +`func (o *GCPCloudProviderContainer) GetAtlasCidrBlockOk() (*string, bool)` + +GetAtlasCidrBlockOk returns a tuple with the AtlasCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAtlasCidrBlock + +`func (o *GCPCloudProviderContainer) SetAtlasCidrBlock(v string)` + +SetAtlasCidrBlock sets AtlasCidrBlock field to given value. + + +### GetGcpProjectId + +`func (o *GCPCloudProviderContainer) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *GCPCloudProviderContainer) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *GCPCloudProviderContainer) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + +### HasGcpProjectId + +`func (o *GCPCloudProviderContainer) HasGcpProjectId() bool` + +HasGcpProjectId returns a boolean if a field has been set. + +### GetNetworkName + +`func (o *GCPCloudProviderContainer) GetNetworkName() string` + +GetNetworkName returns the NetworkName field if non-nil, zero value otherwise. + +### GetNetworkNameOk + +`func (o *GCPCloudProviderContainer) GetNetworkNameOk() (*string, bool)` + +GetNetworkNameOk returns a tuple with the NetworkName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkName + +`func (o *GCPCloudProviderContainer) SetNetworkName(v string)` + +SetNetworkName sets NetworkName field to given value. + +### HasNetworkName + +`func (o *GCPCloudProviderContainer) HasNetworkName() bool` + +HasNetworkName returns a boolean if a field has been set. + +### GetRegions + +`func (o *GCPCloudProviderContainer) GetRegions() []string` + +GetRegions returns the Regions field if non-nil, zero value otherwise. + +### GetRegionsOk + +`func (o *GCPCloudProviderContainer) GetRegionsOk() (*[]string, bool)` + +GetRegionsOk returns a tuple with the Regions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegions + +`func (o *GCPCloudProviderContainer) SetRegions(v []string)` + +SetRegions sets Regions field to given value. + +### HasRegions + +`func (o *GCPCloudProviderContainer) HasRegions() bool` + +HasRegions returns a boolean if a field has been set. + +### GetId + +`func (o *GCPCloudProviderContainer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GCPCloudProviderContainer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GCPCloudProviderContainer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GCPCloudProviderContainer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *GCPCloudProviderContainer) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *GCPCloudProviderContainer) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *GCPCloudProviderContainer) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *GCPCloudProviderContainer) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetProvisioned + +`func (o *GCPCloudProviderContainer) GetProvisioned() bool` + +GetProvisioned returns the Provisioned field if non-nil, zero value otherwise. + +### GetProvisionedOk + +`func (o *GCPCloudProviderContainer) GetProvisionedOk() (*bool, bool)` + +GetProvisionedOk returns a tuple with the Provisioned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioned + +`func (o *GCPCloudProviderContainer) SetProvisioned(v bool)` + +SetProvisioned sets Provisioned field to given value. + +### HasProvisioned + +`func (o *GCPCloudProviderContainer) HasProvisioned() bool` + +HasProvisioned returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPComputeAutoScaling.md b/docs/docs/GCPComputeAutoScaling.md new file mode 100644 index 00000000..4985a405 --- /dev/null +++ b/docs/docs/GCPComputeAutoScaling.md @@ -0,0 +1,82 @@ +# GCPComputeAutoScaling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxInstanceSize** | Pointer to **string** | Maximum instance size to which your cluster can automatically scale. | [optional] +**MinInstanceSize** | Pointer to **string** | Minimum instance size to which your cluster can automatically scale. | [optional] + +## Methods + +### NewGCPComputeAutoScaling + +`func NewGCPComputeAutoScaling() *GCPComputeAutoScaling` + +NewGCPComputeAutoScaling instantiates a new GCPComputeAutoScaling object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPComputeAutoScalingWithDefaults + +`func NewGCPComputeAutoScalingWithDefaults() *GCPComputeAutoScaling` + +NewGCPComputeAutoScalingWithDefaults instantiates a new GCPComputeAutoScaling object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxInstanceSize + +`func (o *GCPComputeAutoScaling) GetMaxInstanceSize() string` + +GetMaxInstanceSize returns the MaxInstanceSize field if non-nil, zero value otherwise. + +### GetMaxInstanceSizeOk + +`func (o *GCPComputeAutoScaling) GetMaxInstanceSizeOk() (*string, bool)` + +GetMaxInstanceSizeOk returns a tuple with the MaxInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxInstanceSize + +`func (o *GCPComputeAutoScaling) SetMaxInstanceSize(v string)` + +SetMaxInstanceSize sets MaxInstanceSize field to given value. + +### HasMaxInstanceSize + +`func (o *GCPComputeAutoScaling) HasMaxInstanceSize() bool` + +HasMaxInstanceSize returns a boolean if a field has been set. + +### GetMinInstanceSize + +`func (o *GCPComputeAutoScaling) GetMinInstanceSize() string` + +GetMinInstanceSize returns the MinInstanceSize field if non-nil, zero value otherwise. + +### GetMinInstanceSizeOk + +`func (o *GCPComputeAutoScaling) GetMinInstanceSizeOk() (*string, bool)` + +GetMinInstanceSizeOk returns a tuple with the MinInstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinInstanceSize + +`func (o *GCPComputeAutoScaling) SetMinInstanceSize(v string)` + +SetMinInstanceSize sets MinInstanceSize field to given value. + +### HasMinInstanceSize + +`func (o *GCPComputeAutoScaling) HasMinInstanceSize() bool` + +HasMinInstanceSize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPConsumerForwardingRule.md b/docs/docs/GCPConsumerForwardingRule.md new file mode 100644 index 00000000..f7e92564 --- /dev/null +++ b/docs/docs/GCPConsumerForwardingRule.md @@ -0,0 +1,108 @@ +# GCPConsumerForwardingRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointName** | Pointer to **string** | Human-readable label that identifies the Google Cloud consumer forwarding rule that you created. | [optional] [readonly] +**IpAddress** | Pointer to **string** | One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves. | [optional] [readonly] +**Status** | Pointer to **string** | State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request. | [optional] [readonly] + +## Methods + +### NewGCPConsumerForwardingRule + +`func NewGCPConsumerForwardingRule() *GCPConsumerForwardingRule` + +NewGCPConsumerForwardingRule instantiates a new GCPConsumerForwardingRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPConsumerForwardingRuleWithDefaults + +`func NewGCPConsumerForwardingRuleWithDefaults() *GCPConsumerForwardingRule` + +NewGCPConsumerForwardingRuleWithDefaults instantiates a new GCPConsumerForwardingRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointName + +`func (o *GCPConsumerForwardingRule) GetEndpointName() string` + +GetEndpointName returns the EndpointName field if non-nil, zero value otherwise. + +### GetEndpointNameOk + +`func (o *GCPConsumerForwardingRule) GetEndpointNameOk() (*string, bool)` + +GetEndpointNameOk returns a tuple with the EndpointName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointName + +`func (o *GCPConsumerForwardingRule) SetEndpointName(v string)` + +SetEndpointName sets EndpointName field to given value. + +### HasEndpointName + +`func (o *GCPConsumerForwardingRule) HasEndpointName() bool` + +HasEndpointName returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *GCPConsumerForwardingRule) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *GCPConsumerForwardingRule) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *GCPConsumerForwardingRule) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *GCPConsumerForwardingRule) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetStatus + +`func (o *GCPConsumerForwardingRule) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GCPConsumerForwardingRule) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GCPConsumerForwardingRule) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GCPConsumerForwardingRule) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPEndpointGroup.md b/docs/docs/GCPEndpointGroup.md new file mode 100644 index 00000000..0425255d --- /dev/null +++ b/docs/docs/GCPEndpointGroup.md @@ -0,0 +1,160 @@ +# GCPEndpointGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DeleteRequested** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service. | [optional] [readonly] +**EndpointGroupName** | Pointer to **string** | Human-readable label that identifies a set of endpoints. | [optional] [readonly] +**Endpoints** | Pointer to [**[]GCPConsumerForwardingRule**](GCPConsumerForwardingRule.md) | List of individual private endpoints that comprise this endpoint group. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Status** | Pointer to **string** | State of the Google Cloud network endpoint group when MongoDB Cloud received this request. | [optional] [readonly] + +## Methods + +### NewGCPEndpointGroup + +`func NewGCPEndpointGroup() *GCPEndpointGroup` + +NewGCPEndpointGroup instantiates a new GCPEndpointGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPEndpointGroupWithDefaults + +`func NewGCPEndpointGroupWithDefaults() *GCPEndpointGroup` + +NewGCPEndpointGroupWithDefaults instantiates a new GCPEndpointGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDeleteRequested + +`func (o *GCPEndpointGroup) GetDeleteRequested() bool` + +GetDeleteRequested returns the DeleteRequested field if non-nil, zero value otherwise. + +### GetDeleteRequestedOk + +`func (o *GCPEndpointGroup) GetDeleteRequestedOk() (*bool, bool)` + +GetDeleteRequestedOk returns a tuple with the DeleteRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteRequested + +`func (o *GCPEndpointGroup) SetDeleteRequested(v bool)` + +SetDeleteRequested sets DeleteRequested field to given value. + +### HasDeleteRequested + +`func (o *GCPEndpointGroup) HasDeleteRequested() bool` + +HasDeleteRequested returns a boolean if a field has been set. + +### GetEndpointGroupName + +`func (o *GCPEndpointGroup) GetEndpointGroupName() string` + +GetEndpointGroupName returns the EndpointGroupName field if non-nil, zero value otherwise. + +### GetEndpointGroupNameOk + +`func (o *GCPEndpointGroup) GetEndpointGroupNameOk() (*string, bool)` + +GetEndpointGroupNameOk returns a tuple with the EndpointGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointGroupName + +`func (o *GCPEndpointGroup) SetEndpointGroupName(v string)` + +SetEndpointGroupName sets EndpointGroupName field to given value. + +### HasEndpointGroupName + +`func (o *GCPEndpointGroup) HasEndpointGroupName() bool` + +HasEndpointGroupName returns a boolean if a field has been set. + +### GetEndpoints + +`func (o *GCPEndpointGroup) GetEndpoints() []GCPConsumerForwardingRule` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *GCPEndpointGroup) GetEndpointsOk() (*[]GCPConsumerForwardingRule, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpoints + +`func (o *GCPEndpointGroup) SetEndpoints(v []GCPConsumerForwardingRule)` + +SetEndpoints sets Endpoints field to given value. + +### HasEndpoints + +`func (o *GCPEndpointGroup) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *GCPEndpointGroup) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *GCPEndpointGroup) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *GCPEndpointGroup) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *GCPEndpointGroup) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetStatus + +`func (o *GCPEndpointGroup) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GCPEndpointGroup) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GCPEndpointGroup) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GCPEndpointGroup) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPEndpointService.md b/docs/docs/GCPEndpointService.md new file mode 100644 index 00000000..c1e9eb82 --- /dev/null +++ b/docs/docs/GCPEndpointService.md @@ -0,0 +1,186 @@ +# GCPEndpointService + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointGroupNames** | Pointer to **[]string** | List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service. | [optional] +**ErrorMessage** | Pointer to **string** | Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. | [optional] [readonly] +**RegionName** | Pointer to **string** | Cloud provider region that manages this Private Endpoint Service. | [optional] [readonly] +**ServiceAttachmentNames** | Pointer to **[]string** | List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network. | [optional] +**Status** | Pointer to **string** | State of the Private Endpoint Service connection when MongoDB Cloud received this request. | [optional] [readonly] + +## Methods + +### NewGCPEndpointService + +`func NewGCPEndpointService() *GCPEndpointService` + +NewGCPEndpointService instantiates a new GCPEndpointService object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPEndpointServiceWithDefaults + +`func NewGCPEndpointServiceWithDefaults() *GCPEndpointService` + +NewGCPEndpointServiceWithDefaults instantiates a new GCPEndpointService object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointGroupNames + +`func (o *GCPEndpointService) GetEndpointGroupNames() []string` + +GetEndpointGroupNames returns the EndpointGroupNames field if non-nil, zero value otherwise. + +### GetEndpointGroupNamesOk + +`func (o *GCPEndpointService) GetEndpointGroupNamesOk() (*[]string, bool)` + +GetEndpointGroupNamesOk returns a tuple with the EndpointGroupNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointGroupNames + +`func (o *GCPEndpointService) SetEndpointGroupNames(v []string)` + +SetEndpointGroupNames sets EndpointGroupNames field to given value. + +### HasEndpointGroupNames + +`func (o *GCPEndpointService) HasEndpointGroupNames() bool` + +HasEndpointGroupNames returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *GCPEndpointService) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *GCPEndpointService) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *GCPEndpointService) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *GCPEndpointService) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetId + +`func (o *GCPEndpointService) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GCPEndpointService) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GCPEndpointService) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GCPEndpointService) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRegionName + +`func (o *GCPEndpointService) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *GCPEndpointService) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *GCPEndpointService) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *GCPEndpointService) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetServiceAttachmentNames + +`func (o *GCPEndpointService) GetServiceAttachmentNames() []string` + +GetServiceAttachmentNames returns the ServiceAttachmentNames field if non-nil, zero value otherwise. + +### GetServiceAttachmentNamesOk + +`func (o *GCPEndpointService) GetServiceAttachmentNamesOk() (*[]string, bool)` + +GetServiceAttachmentNamesOk returns a tuple with the ServiceAttachmentNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceAttachmentNames + +`func (o *GCPEndpointService) SetServiceAttachmentNames(v []string)` + +SetServiceAttachmentNames sets ServiceAttachmentNames field to given value. + +### HasServiceAttachmentNames + +`func (o *GCPEndpointService) HasServiceAttachmentNames() bool` + +HasServiceAttachmentNames returns a boolean if a field has been set. + +### GetStatus + +`func (o *GCPEndpointService) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GCPEndpointService) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GCPEndpointService) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GCPEndpointService) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPHardwareSpec.md b/docs/docs/GCPHardwareSpec.md new file mode 100644 index 00000000..143ec533 --- /dev/null +++ b/docs/docs/GCPHardwareSpec.md @@ -0,0 +1,82 @@ +# GCPHardwareSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InstanceSize** | Pointer to **string** | Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. | [optional] +**NodeCount** | Pointer to **int** | Number of nodes of the given type for MongoDB Cloud to deploy to the region. | [optional] + +## Methods + +### NewGCPHardwareSpec + +`func NewGCPHardwareSpec() *GCPHardwareSpec` + +NewGCPHardwareSpec instantiates a new GCPHardwareSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPHardwareSpecWithDefaults + +`func NewGCPHardwareSpecWithDefaults() *GCPHardwareSpec` + +NewGCPHardwareSpecWithDefaults instantiates a new GCPHardwareSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInstanceSize + +`func (o *GCPHardwareSpec) GetInstanceSize() string` + +GetInstanceSize returns the InstanceSize field if non-nil, zero value otherwise. + +### GetInstanceSizeOk + +`func (o *GCPHardwareSpec) GetInstanceSizeOk() (*string, bool)` + +GetInstanceSizeOk returns a tuple with the InstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSize + +`func (o *GCPHardwareSpec) SetInstanceSize(v string)` + +SetInstanceSize sets InstanceSize field to given value. + +### HasInstanceSize + +`func (o *GCPHardwareSpec) HasInstanceSize() bool` + +HasInstanceSize returns a boolean if a field has been set. + +### GetNodeCount + +`func (o *GCPHardwareSpec) GetNodeCount() int` + +GetNodeCount returns the NodeCount field if non-nil, zero value otherwise. + +### GetNodeCountOk + +`func (o *GCPHardwareSpec) GetNodeCountOk() (*int, bool)` + +GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNodeCount + +`func (o *GCPHardwareSpec) SetNodeCount(v int)` + +SetNodeCount sets NodeCount field to given value. + +### HasNodeCount + +`func (o *GCPHardwareSpec) HasNodeCount() bool` + +HasNodeCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPPeerVpc.md b/docs/docs/GCPPeerVpc.md new file mode 100644 index 00000000..0c975432 --- /dev/null +++ b/docs/docs/GCPPeerVpc.md @@ -0,0 +1,197 @@ +# GCPPeerVpc + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ErrorMessage** | Pointer to **string** | Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**GcpProjectId** | **string** | Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC. | +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**NetworkName** | **string** | Human-readable label that identifies the network to peer with the MongoDB Cloud VPC. | +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering connection. | [optional] +**Status** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] + +## Methods + +### NewGCPPeerVpc + +`func NewGCPPeerVpc(containerId string, gcpProjectId string, networkName string, ) *GCPPeerVpc` + +NewGCPPeerVpc instantiates a new GCPPeerVpc object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPPeerVpcWithDefaults + +`func NewGCPPeerVpcWithDefaults() *GCPPeerVpc` + +NewGCPPeerVpcWithDefaults instantiates a new GCPPeerVpc object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContainerId + +`func (o *GCPPeerVpc) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *GCPPeerVpc) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *GCPPeerVpc) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetErrorMessage + +`func (o *GCPPeerVpc) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *GCPPeerVpc) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *GCPPeerVpc) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *GCPPeerVpc) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *GCPPeerVpc) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *GCPPeerVpc) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *GCPPeerVpc) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + + +### GetId + +`func (o *GCPPeerVpc) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GCPPeerVpc) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GCPPeerVpc) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GCPPeerVpc) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNetworkName + +`func (o *GCPPeerVpc) GetNetworkName() string` + +GetNetworkName returns the NetworkName field if non-nil, zero value otherwise. + +### GetNetworkNameOk + +`func (o *GCPPeerVpc) GetNetworkNameOk() (*string, bool)` + +GetNetworkNameOk returns a tuple with the NetworkName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkName + +`func (o *GCPPeerVpc) SetNetworkName(v string)` + +SetNetworkName sets NetworkName field to given value. + + +### GetProviderName + +`func (o *GCPPeerVpc) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *GCPPeerVpc) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *GCPPeerVpc) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *GCPPeerVpc) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetStatus + +`func (o *GCPPeerVpc) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GCPPeerVpc) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GCPPeerVpc) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GCPPeerVpc) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPPeerVpcRequest.md b/docs/docs/GCPPeerVpcRequest.md new file mode 100644 index 00000000..c8e9514d --- /dev/null +++ b/docs/docs/GCPPeerVpcRequest.md @@ -0,0 +1,192 @@ +# GCPPeerVpcRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ProviderName** | **string** | Cloud service provider that serves the requested network peering connection. | +**ErrorMessage** | Pointer to **string** | Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**GcpProjectId** | **string** | Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC. | +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**NetworkName** | **string** | Human-readable label that identifies the network to peer with the MongoDB Cloud VPC. | +**Status** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] + +## Methods + +### NewGCPPeerVpcRequest + +`func NewGCPPeerVpcRequest(containerId string, providerName string, gcpProjectId string, networkName string, ) *GCPPeerVpcRequest` + +NewGCPPeerVpcRequest instantiates a new GCPPeerVpcRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPPeerVpcRequestWithDefaults + +`func NewGCPPeerVpcRequestWithDefaults() *GCPPeerVpcRequest` + +NewGCPPeerVpcRequestWithDefaults instantiates a new GCPPeerVpcRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContainerId + +`func (o *GCPPeerVpcRequest) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *GCPPeerVpcRequest) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *GCPPeerVpcRequest) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetProviderName + +`func (o *GCPPeerVpcRequest) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *GCPPeerVpcRequest) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *GCPPeerVpcRequest) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetErrorMessage + +`func (o *GCPPeerVpcRequest) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *GCPPeerVpcRequest) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *GCPPeerVpcRequest) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *GCPPeerVpcRequest) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *GCPPeerVpcRequest) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *GCPPeerVpcRequest) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *GCPPeerVpcRequest) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + + +### GetId + +`func (o *GCPPeerVpcRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GCPPeerVpcRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GCPPeerVpcRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GCPPeerVpcRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNetworkName + +`func (o *GCPPeerVpcRequest) GetNetworkName() string` + +GetNetworkName returns the NetworkName field if non-nil, zero value otherwise. + +### GetNetworkNameOk + +`func (o *GCPPeerVpcRequest) GetNetworkNameOk() (*string, bool)` + +GetNetworkNameOk returns a tuple with the NetworkName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkName + +`func (o *GCPPeerVpcRequest) SetNetworkName(v string)` + +SetNetworkName sets NetworkName field to given value. + + +### GetStatus + +`func (o *GCPPeerVpcRequest) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GCPPeerVpcRequest) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GCPPeerVpcRequest) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GCPPeerVpcRequest) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPProviderSettings.md b/docs/docs/GCPProviderSettings.md new file mode 100644 index 00000000..efe9073c --- /dev/null +++ b/docs/docs/GCPProviderSettings.md @@ -0,0 +1,129 @@ +# GCPProviderSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoScaling** | Pointer to [**GCPAutoScaling**](GCPAutoScaling.md) | | [optional] +**InstanceSizeName** | Pointer to **string** | Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. | [optional] +**RegionName** | Pointer to **string** | Google Compute Regions. | [optional] +**ProviderName** | **string** | | + +## Methods + +### NewGCPProviderSettings + +`func NewGCPProviderSettings(providerName string, ) *GCPProviderSettings` + +NewGCPProviderSettings instantiates a new GCPProviderSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPProviderSettingsWithDefaults + +`func NewGCPProviderSettingsWithDefaults() *GCPProviderSettings` + +NewGCPProviderSettingsWithDefaults instantiates a new GCPProviderSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoScaling + +`func (o *GCPProviderSettings) GetAutoScaling() GCPAutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *GCPProviderSettings) GetAutoScalingOk() (*GCPAutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *GCPProviderSettings) SetAutoScaling(v GCPAutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *GCPProviderSettings) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetInstanceSizeName + +`func (o *GCPProviderSettings) GetInstanceSizeName() string` + +GetInstanceSizeName returns the InstanceSizeName field if non-nil, zero value otherwise. + +### GetInstanceSizeNameOk + +`func (o *GCPProviderSettings) GetInstanceSizeNameOk() (*string, bool)` + +GetInstanceSizeNameOk returns a tuple with the InstanceSizeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSizeName + +`func (o *GCPProviderSettings) SetInstanceSizeName(v string)` + +SetInstanceSizeName sets InstanceSizeName field to given value. + +### HasInstanceSizeName + +`func (o *GCPProviderSettings) HasInstanceSizeName() bool` + +HasInstanceSizeName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *GCPProviderSettings) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *GCPProviderSettings) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *GCPProviderSettings) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *GCPProviderSettings) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetProviderName + +`func (o *GCPProviderSettings) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *GCPProviderSettings) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *GCPProviderSettings) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GCPRegionConfig.md b/docs/docs/GCPRegionConfig.md new file mode 100644 index 00000000..b5ec1e88 --- /dev/null +++ b/docs/docs/GCPRegionConfig.md @@ -0,0 +1,238 @@ +# GCPRegionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AnalyticsAutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**AnalyticsSpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**AutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**ReadOnlySpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**ElectableSpecs** | Pointer to [**HardwareSpec**](HardwareSpec.md) | | [optional] +**Priority** | Pointer to **int** | Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`. **Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively. | [optional] +**ProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`. | [optional] +**RegionName** | Pointer to **string** | Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. | [optional] + +## Methods + +### NewGCPRegionConfig + +`func NewGCPRegionConfig() *GCPRegionConfig` + +NewGCPRegionConfig instantiates a new GCPRegionConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGCPRegionConfigWithDefaults + +`func NewGCPRegionConfigWithDefaults() *GCPRegionConfig` + +NewGCPRegionConfigWithDefaults instantiates a new GCPRegionConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAnalyticsAutoScaling + +`func (o *GCPRegionConfig) GetAnalyticsAutoScaling() AutoScalingV15` + +GetAnalyticsAutoScaling returns the AnalyticsAutoScaling field if non-nil, zero value otherwise. + +### GetAnalyticsAutoScalingOk + +`func (o *GCPRegionConfig) GetAnalyticsAutoScalingOk() (*AutoScalingV15, bool)` + +GetAnalyticsAutoScalingOk returns a tuple with the AnalyticsAutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsAutoScaling + +`func (o *GCPRegionConfig) SetAnalyticsAutoScaling(v AutoScalingV15)` + +SetAnalyticsAutoScaling sets AnalyticsAutoScaling field to given value. + +### HasAnalyticsAutoScaling + +`func (o *GCPRegionConfig) HasAnalyticsAutoScaling() bool` + +HasAnalyticsAutoScaling returns a boolean if a field has been set. + +### GetAnalyticsSpecs + +`func (o *GCPRegionConfig) GetAnalyticsSpecs() DedicatedHardwareSpec` + +GetAnalyticsSpecs returns the AnalyticsSpecs field if non-nil, zero value otherwise. + +### GetAnalyticsSpecsOk + +`func (o *GCPRegionConfig) GetAnalyticsSpecsOk() (*DedicatedHardwareSpec, bool)` + +GetAnalyticsSpecsOk returns a tuple with the AnalyticsSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsSpecs + +`func (o *GCPRegionConfig) SetAnalyticsSpecs(v DedicatedHardwareSpec)` + +SetAnalyticsSpecs sets AnalyticsSpecs field to given value. + +### HasAnalyticsSpecs + +`func (o *GCPRegionConfig) HasAnalyticsSpecs() bool` + +HasAnalyticsSpecs returns a boolean if a field has been set. + +### GetAutoScaling + +`func (o *GCPRegionConfig) GetAutoScaling() AutoScalingV15` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *GCPRegionConfig) GetAutoScalingOk() (*AutoScalingV15, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *GCPRegionConfig) SetAutoScaling(v AutoScalingV15)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *GCPRegionConfig) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetReadOnlySpecs + +`func (o *GCPRegionConfig) GetReadOnlySpecs() DedicatedHardwareSpec` + +GetReadOnlySpecs returns the ReadOnlySpecs field if non-nil, zero value otherwise. + +### GetReadOnlySpecsOk + +`func (o *GCPRegionConfig) GetReadOnlySpecsOk() (*DedicatedHardwareSpec, bool)` + +GetReadOnlySpecsOk returns a tuple with the ReadOnlySpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadOnlySpecs + +`func (o *GCPRegionConfig) SetReadOnlySpecs(v DedicatedHardwareSpec)` + +SetReadOnlySpecs sets ReadOnlySpecs field to given value. + +### HasReadOnlySpecs + +`func (o *GCPRegionConfig) HasReadOnlySpecs() bool` + +HasReadOnlySpecs returns a boolean if a field has been set. + +### GetElectableSpecs + +`func (o *GCPRegionConfig) GetElectableSpecs() HardwareSpec` + +GetElectableSpecs returns the ElectableSpecs field if non-nil, zero value otherwise. + +### GetElectableSpecsOk + +`func (o *GCPRegionConfig) GetElectableSpecsOk() (*HardwareSpec, bool)` + +GetElectableSpecsOk returns a tuple with the ElectableSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElectableSpecs + +`func (o *GCPRegionConfig) SetElectableSpecs(v HardwareSpec)` + +SetElectableSpecs sets ElectableSpecs field to given value. + +### HasElectableSpecs + +`func (o *GCPRegionConfig) HasElectableSpecs() bool` + +HasElectableSpecs returns a boolean if a field has been set. + +### GetPriority + +`func (o *GCPRegionConfig) GetPriority() int` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *GCPRegionConfig) GetPriorityOk() (*int, bool)` + +GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPriority + +`func (o *GCPRegionConfig) SetPriority(v int)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *GCPRegionConfig) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetProviderName + +`func (o *GCPRegionConfig) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *GCPRegionConfig) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *GCPRegionConfig) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *GCPRegionConfig) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *GCPRegionConfig) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *GCPRegionConfig) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *GCPRegionConfig) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *GCPRegionConfig) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GeoSharding.md b/docs/docs/GeoSharding.md new file mode 100644 index 00000000..591d4428 --- /dev/null +++ b/docs/docs/GeoSharding.md @@ -0,0 +1,82 @@ +# GeoSharding + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomZoneMapping** | Pointer to **map[string]string** | List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. This parameter returns an empty object if no custom zones exist. | [optional] [readonly] +**ManagedNamespaces** | Pointer to [**[]ManagedNamespaces**](ManagedNamespaces.md) | List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster. | [optional] [readonly] + +## Methods + +### NewGeoSharding + +`func NewGeoSharding() *GeoSharding` + +NewGeoSharding instantiates a new GeoSharding object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGeoShardingWithDefaults + +`func NewGeoShardingWithDefaults() *GeoSharding` + +NewGeoShardingWithDefaults instantiates a new GeoSharding object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCustomZoneMapping + +`func (o *GeoSharding) GetCustomZoneMapping() map[string]string` + +GetCustomZoneMapping returns the CustomZoneMapping field if non-nil, zero value otherwise. + +### GetCustomZoneMappingOk + +`func (o *GeoSharding) GetCustomZoneMappingOk() (*map[string]string, bool)` + +GetCustomZoneMappingOk returns a tuple with the CustomZoneMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomZoneMapping + +`func (o *GeoSharding) SetCustomZoneMapping(v map[string]string)` + +SetCustomZoneMapping sets CustomZoneMapping field to given value. + +### HasCustomZoneMapping + +`func (o *GeoSharding) HasCustomZoneMapping() bool` + +HasCustomZoneMapping returns a boolean if a field has been set. + +### GetManagedNamespaces + +`func (o *GeoSharding) GetManagedNamespaces() []ManagedNamespaces` + +GetManagedNamespaces returns the ManagedNamespaces field if non-nil, zero value otherwise. + +### GetManagedNamespacesOk + +`func (o *GeoSharding) GetManagedNamespacesOk() (*[]ManagedNamespaces, bool)` + +GetManagedNamespacesOk returns a tuple with the ManagedNamespaces field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedNamespaces + +`func (o *GeoSharding) SetManagedNamespaces(v []ManagedNamespaces)` + +SetManagedNamespaces sets ManagedNamespaces field to given value. + +### HasManagedNamespaces + +`func (o *GeoSharding) HasManagedNamespaces() bool` + +HasManagedNamespaces returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GetPeeringConnection200Response.md b/docs/docs/GetPeeringConnection200Response.md new file mode 100644 index 00000000..e2d3ff66 --- /dev/null +++ b/docs/docs/GetPeeringConnection200Response.md @@ -0,0 +1,469 @@ +# GetPeeringConnection200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccepterRegionName** | **string** | Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region. | +**AwsAccountId** | **string** | Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. | +**ConnectionId** | Pointer to **string** | Unique string that identifies the peering connection on AWS. | [optional] [readonly] +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ErrorStateName** | Pointer to **string** | Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering connection. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering connection. | [optional] +**RouteTableCidrBlock** | **string** | Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. | +**StatusName** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VpcId** | **string** | Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. | +**AzureDirectoryId** | **string** | Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides. | +**AzureSubscriptionId** | **string** | Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides. | +**ErrorState** | Pointer to **string** | Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded. | [optional] [readonly] +**ResourceGroupName** | **string** | Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides. | +**Status** | Pointer to **string** | State of the network peering connection at the time you made the request. | [optional] [readonly] +**VnetName** | **string** | Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet. | +**ErrorMessage** | Pointer to **string** | Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded. | [optional] [readonly] +**GcpProjectId** | **string** | Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC. | +**NetworkName** | **string** | Human-readable label that identifies the network to peer with the MongoDB Cloud VPC. | + +## Methods + +### NewGetPeeringConnection200Response + +`func NewGetPeeringConnection200Response(accepterRegionName string, awsAccountId string, containerId string, routeTableCidrBlock string, vpcId string, azureDirectoryId string, azureSubscriptionId string, resourceGroupName string, vnetName string, gcpProjectId string, networkName string, ) *GetPeeringConnection200Response` + +NewGetPeeringConnection200Response instantiates a new GetPeeringConnection200Response object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetPeeringConnection200ResponseWithDefaults + +`func NewGetPeeringConnection200ResponseWithDefaults() *GetPeeringConnection200Response` + +NewGetPeeringConnection200ResponseWithDefaults instantiates a new GetPeeringConnection200Response object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccepterRegionName + +`func (o *GetPeeringConnection200Response) GetAccepterRegionName() string` + +GetAccepterRegionName returns the AccepterRegionName field if non-nil, zero value otherwise. + +### GetAccepterRegionNameOk + +`func (o *GetPeeringConnection200Response) GetAccepterRegionNameOk() (*string, bool)` + +GetAccepterRegionNameOk returns a tuple with the AccepterRegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccepterRegionName + +`func (o *GetPeeringConnection200Response) SetAccepterRegionName(v string)` + +SetAccepterRegionName sets AccepterRegionName field to given value. + + +### GetAwsAccountId + +`func (o *GetPeeringConnection200Response) GetAwsAccountId() string` + +GetAwsAccountId returns the AwsAccountId field if non-nil, zero value otherwise. + +### GetAwsAccountIdOk + +`func (o *GetPeeringConnection200Response) GetAwsAccountIdOk() (*string, bool)` + +GetAwsAccountIdOk returns a tuple with the AwsAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccountId + +`func (o *GetPeeringConnection200Response) SetAwsAccountId(v string)` + +SetAwsAccountId sets AwsAccountId field to given value. + + +### GetConnectionId + +`func (o *GetPeeringConnection200Response) GetConnectionId() string` + +GetConnectionId returns the ConnectionId field if non-nil, zero value otherwise. + +### GetConnectionIdOk + +`func (o *GetPeeringConnection200Response) GetConnectionIdOk() (*string, bool)` + +GetConnectionIdOk returns a tuple with the ConnectionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionId + +`func (o *GetPeeringConnection200Response) SetConnectionId(v string)` + +SetConnectionId sets ConnectionId field to given value. + +### HasConnectionId + +`func (o *GetPeeringConnection200Response) HasConnectionId() bool` + +HasConnectionId returns a boolean if a field has been set. + +### GetContainerId + +`func (o *GetPeeringConnection200Response) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *GetPeeringConnection200Response) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *GetPeeringConnection200Response) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetErrorStateName + +`func (o *GetPeeringConnection200Response) GetErrorStateName() string` + +GetErrorStateName returns the ErrorStateName field if non-nil, zero value otherwise. + +### GetErrorStateNameOk + +`func (o *GetPeeringConnection200Response) GetErrorStateNameOk() (*string, bool)` + +GetErrorStateNameOk returns a tuple with the ErrorStateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorStateName + +`func (o *GetPeeringConnection200Response) SetErrorStateName(v string)` + +SetErrorStateName sets ErrorStateName field to given value. + +### HasErrorStateName + +`func (o *GetPeeringConnection200Response) HasErrorStateName() bool` + +HasErrorStateName returns a boolean if a field has been set. + +### GetId + +`func (o *GetPeeringConnection200Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetPeeringConnection200Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetPeeringConnection200Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetPeeringConnection200Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *GetPeeringConnection200Response) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *GetPeeringConnection200Response) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *GetPeeringConnection200Response) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *GetPeeringConnection200Response) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRouteTableCidrBlock + +`func (o *GetPeeringConnection200Response) GetRouteTableCidrBlock() string` + +GetRouteTableCidrBlock returns the RouteTableCidrBlock field if non-nil, zero value otherwise. + +### GetRouteTableCidrBlockOk + +`func (o *GetPeeringConnection200Response) GetRouteTableCidrBlockOk() (*string, bool)` + +GetRouteTableCidrBlockOk returns a tuple with the RouteTableCidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRouteTableCidrBlock + +`func (o *GetPeeringConnection200Response) SetRouteTableCidrBlock(v string)` + +SetRouteTableCidrBlock sets RouteTableCidrBlock field to given value. + + +### GetStatusName + +`func (o *GetPeeringConnection200Response) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *GetPeeringConnection200Response) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *GetPeeringConnection200Response) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *GetPeeringConnection200Response) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetVpcId + +`func (o *GetPeeringConnection200Response) GetVpcId() string` + +GetVpcId returns the VpcId field if non-nil, zero value otherwise. + +### GetVpcIdOk + +`func (o *GetPeeringConnection200Response) GetVpcIdOk() (*string, bool)` + +GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVpcId + +`func (o *GetPeeringConnection200Response) SetVpcId(v string)` + +SetVpcId sets VpcId field to given value. + + +### GetAzureDirectoryId + +`func (o *GetPeeringConnection200Response) GetAzureDirectoryId() string` + +GetAzureDirectoryId returns the AzureDirectoryId field if non-nil, zero value otherwise. + +### GetAzureDirectoryIdOk + +`func (o *GetPeeringConnection200Response) GetAzureDirectoryIdOk() (*string, bool)` + +GetAzureDirectoryIdOk returns a tuple with the AzureDirectoryId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureDirectoryId + +`func (o *GetPeeringConnection200Response) SetAzureDirectoryId(v string)` + +SetAzureDirectoryId sets AzureDirectoryId field to given value. + + +### GetAzureSubscriptionId + +`func (o *GetPeeringConnection200Response) GetAzureSubscriptionId() string` + +GetAzureSubscriptionId returns the AzureSubscriptionId field if non-nil, zero value otherwise. + +### GetAzureSubscriptionIdOk + +`func (o *GetPeeringConnection200Response) GetAzureSubscriptionIdOk() (*string, bool)` + +GetAzureSubscriptionIdOk returns a tuple with the AzureSubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAzureSubscriptionId + +`func (o *GetPeeringConnection200Response) SetAzureSubscriptionId(v string)` + +SetAzureSubscriptionId sets AzureSubscriptionId field to given value. + + +### GetErrorState + +`func (o *GetPeeringConnection200Response) GetErrorState() string` + +GetErrorState returns the ErrorState field if non-nil, zero value otherwise. + +### GetErrorStateOk + +`func (o *GetPeeringConnection200Response) GetErrorStateOk() (*string, bool)` + +GetErrorStateOk returns a tuple with the ErrorState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorState + +`func (o *GetPeeringConnection200Response) SetErrorState(v string)` + +SetErrorState sets ErrorState field to given value. + +### HasErrorState + +`func (o *GetPeeringConnection200Response) HasErrorState() bool` + +HasErrorState returns a boolean if a field has been set. + +### GetResourceGroupName + +`func (o *GetPeeringConnection200Response) GetResourceGroupName() string` + +GetResourceGroupName returns the ResourceGroupName field if non-nil, zero value otherwise. + +### GetResourceGroupNameOk + +`func (o *GetPeeringConnection200Response) GetResourceGroupNameOk() (*string, bool)` + +GetResourceGroupNameOk returns a tuple with the ResourceGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceGroupName + +`func (o *GetPeeringConnection200Response) SetResourceGroupName(v string)` + +SetResourceGroupName sets ResourceGroupName field to given value. + + +### GetStatus + +`func (o *GetPeeringConnection200Response) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetPeeringConnection200Response) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetPeeringConnection200Response) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetPeeringConnection200Response) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetVnetName + +`func (o *GetPeeringConnection200Response) GetVnetName() string` + +GetVnetName returns the VnetName field if non-nil, zero value otherwise. + +### GetVnetNameOk + +`func (o *GetPeeringConnection200Response) GetVnetNameOk() (*string, bool)` + +GetVnetNameOk returns a tuple with the VnetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVnetName + +`func (o *GetPeeringConnection200Response) SetVnetName(v string)` + +SetVnetName sets VnetName field to given value. + + +### GetErrorMessage + +`func (o *GetPeeringConnection200Response) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *GetPeeringConnection200Response) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *GetPeeringConnection200Response) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *GetPeeringConnection200Response) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetGcpProjectId + +`func (o *GetPeeringConnection200Response) GetGcpProjectId() string` + +GetGcpProjectId returns the GcpProjectId field if non-nil, zero value otherwise. + +### GetGcpProjectIdOk + +`func (o *GetPeeringConnection200Response) GetGcpProjectIdOk() (*string, bool)` + +GetGcpProjectIdOk returns a tuple with the GcpProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGcpProjectId + +`func (o *GetPeeringConnection200Response) SetGcpProjectId(v string)` + +SetGcpProjectId sets GcpProjectId field to given value. + + +### GetNetworkName + +`func (o *GetPeeringConnection200Response) GetNetworkName() string` + +GetNetworkName returns the NetworkName field if non-nil, zero value otherwise. + +### GetNetworkNameOk + +`func (o *GetPeeringConnection200Response) GetNetworkNameOk() (*string, bool)` + +GetNetworkNameOk returns a tuple with the NetworkName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkName + +`func (o *GetPeeringConnection200Response) SetNetworkName(v string)` + +SetNetworkName sets NetworkName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GlobalClustersApi.md b/docs/docs/GlobalClustersApi.md new file mode 100644 index 00000000..dd9d0a90 --- /dev/null +++ b/docs/docs/GlobalClustersApi.md @@ -0,0 +1,406 @@ +# \GlobalClustersApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateCustomZoneMapping**](GlobalClustersApi.md#CreateCustomZoneMapping) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping | Add One Entry to One Custom Zone Mapping +[**CreateManagedNamespace**](GlobalClustersApi.md#CreateManagedNamespace) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces | Create One Managed Namespace in One Global Multi-Cloud Cluster +[**DeleteAllCustomZoneMappings**](GlobalClustersApi.md#DeleteAllCustomZoneMappings) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping | Remove All Custom Zone Mappings from One Global Multi-Cloud Cluster +[**DeleteManagedNamespace**](GlobalClustersApi.md#DeleteManagedNamespace) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces | Remove One Managed Namespace from One Global Multi-Cloud Cluster +[**GetManagedNamespace**](GlobalClustersApi.md#GetManagedNamespace) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites | Return One Managed Namespace in One Global Multi-Cloud Cluster + + + +## CreateCustomZoneMapping + +> GeoSharding CreateCustomZoneMapping(ctx, groupId, clusterName).GeoSharding(geoSharding).Execute() + +Add One Entry to One Custom Zone Mapping + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + geoSharding := *openapiclient.NewGeoSharding() // GeoSharding | + + resp, r, err := sdk.GlobalClustersApi.CreateCustomZoneMapping(context.Background(), groupId, clusterName).GeoSharding(geoSharding).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalClustersApi.CreateCustomZoneMapping``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateCustomZoneMapping`: GeoSharding + fmt.Fprintf(os.Stdout, "Response from `GlobalClustersApi.CreateCustomZoneMapping`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies this advanced cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomZoneMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **geoSharding** | [**GeoSharding**](GeoSharding.md) | Custom zone mapping to add to the specified global cluster. | + +### Return type + +[**GeoSharding**](GeoSharding.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-02-01+json +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateManagedNamespace + +> GeoSharding CreateManagedNamespace(ctx, groupId, clusterName).ManagedNamespace(managedNamespace).Execute() + +Create One Managed Namespace in One Global Multi-Cloud Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + managedNamespace := *openapiclient.NewManagedNamespace() // ManagedNamespace | + + resp, r, err := sdk.GlobalClustersApi.CreateManagedNamespace(context.Background(), groupId, clusterName).ManagedNamespace(managedNamespace).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalClustersApi.CreateManagedNamespace``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateManagedNamespace`: GeoSharding + fmt.Fprintf(os.Stdout, "Response from `GlobalClustersApi.CreateManagedNamespace`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies this advanced cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedNamespaceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **managedNamespace** | [**ManagedNamespace**](ManagedNamespace.md) | Managed namespace to create within the specified global cluster. | + +### Return type + +[**GeoSharding**](GeoSharding.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-02-01+json +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteAllCustomZoneMappings + +> GeoSharding DeleteAllCustomZoneMappings(ctx, groupId, clusterName).Execute() + +Remove All Custom Zone Mappings from One Global Multi-Cloud Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.GlobalClustersApi.DeleteAllCustomZoneMappings(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalClustersApi.DeleteAllCustomZoneMappings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DeleteAllCustomZoneMappings`: GeoSharding + fmt.Fprintf(os.Stdout, "Response from `GlobalClustersApi.DeleteAllCustomZoneMappings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies this advanced cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAllCustomZoneMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**GeoSharding**](GeoSharding.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteManagedNamespace + +> GeoSharding DeleteManagedNamespace(ctx, clusterName, groupId).Db(db).Collection(collection).Execute() + +Remove One Managed Namespace from One Global Multi-Cloud Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + clusterName := "clusterName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + db := "db_example" // string | (optional) + collection := "collection_example" // string | (optional) + + resp, r, err := sdk.GlobalClustersApi.DeleteManagedNamespace(context.Background(), clusterName, groupId).Db(db).Collection(collection).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalClustersApi.DeleteManagedNamespace``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DeleteManagedNamespace`: GeoSharding + fmt.Fprintf(os.Stdout, "Response from `GlobalClustersApi.DeleteManagedNamespace`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**clusterName** | **string** | Human-readable label that identifies this advanced cluster. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedNamespaceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **db** | **string** | Human-readable label that identifies the database that contains the collection. | + **collection** | **string** | Human-readable label that identifies the collection associated with the managed namespace. | + +### Return type + +[**GeoSharding**](GeoSharding.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetManagedNamespace + +> GeoSharding GetManagedNamespace(ctx, groupId, clusterName).Execute() + +Return One Managed Namespace in One Global Multi-Cloud Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.GlobalClustersApi.GetManagedNamespace(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalClustersApi.GetManagedNamespace``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetManagedNamespace`: GeoSharding + fmt.Fprintf(os.Stdout, "Response from `GlobalClustersApi.GetManagedNamespace`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies this advanced cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedNamespaceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**GeoSharding**](GeoSharding.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/GoogleCloudKMS.md b/docs/docs/GoogleCloudKMS.md new file mode 100644 index 00000000..e5feb35c --- /dev/null +++ b/docs/docs/GoogleCloudKMS.md @@ -0,0 +1,134 @@ +# GoogleCloudKMS + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`. | [optional] +**KeyVersionResourceID** | Pointer to **string** | Resource path that displays the key version resource ID for your Google Cloud KMS. | [optional] +**ServiceAccountKey** | Pointer to **string** | JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object. | [optional] +**Valid** | Pointer to **bool** | Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data. | [optional] [readonly] + +## Methods + +### NewGoogleCloudKMS + +`func NewGoogleCloudKMS() *GoogleCloudKMS` + +NewGoogleCloudKMS instantiates a new GoogleCloudKMS object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGoogleCloudKMSWithDefaults + +`func NewGoogleCloudKMSWithDefaults() *GoogleCloudKMS` + +NewGoogleCloudKMSWithDefaults instantiates a new GoogleCloudKMS object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *GoogleCloudKMS) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *GoogleCloudKMS) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *GoogleCloudKMS) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *GoogleCloudKMS) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetKeyVersionResourceID + +`func (o *GoogleCloudKMS) GetKeyVersionResourceID() string` + +GetKeyVersionResourceID returns the KeyVersionResourceID field if non-nil, zero value otherwise. + +### GetKeyVersionResourceIDOk + +`func (o *GoogleCloudKMS) GetKeyVersionResourceIDOk() (*string, bool)` + +GetKeyVersionResourceIDOk returns a tuple with the KeyVersionResourceID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeyVersionResourceID + +`func (o *GoogleCloudKMS) SetKeyVersionResourceID(v string)` + +SetKeyVersionResourceID sets KeyVersionResourceID field to given value. + +### HasKeyVersionResourceID + +`func (o *GoogleCloudKMS) HasKeyVersionResourceID() bool` + +HasKeyVersionResourceID returns a boolean if a field has been set. + +### GetServiceAccountKey + +`func (o *GoogleCloudKMS) GetServiceAccountKey() string` + +GetServiceAccountKey returns the ServiceAccountKey field if non-nil, zero value otherwise. + +### GetServiceAccountKeyOk + +`func (o *GoogleCloudKMS) GetServiceAccountKeyOk() (*string, bool)` + +GetServiceAccountKeyOk returns a tuple with the ServiceAccountKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceAccountKey + +`func (o *GoogleCloudKMS) SetServiceAccountKey(v string)` + +SetServiceAccountKey sets ServiceAccountKey field to given value. + +### HasServiceAccountKey + +`func (o *GoogleCloudKMS) HasServiceAccountKey() bool` + +HasServiceAccountKey returns a boolean if a field has been set. + +### GetValid + +`func (o *GoogleCloudKMS) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *GoogleCloudKMS) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *GoogleCloudKMS) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *GoogleCloudKMS) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GreaterThanDaysThreshold.md b/docs/docs/GreaterThanDaysThreshold.md new file mode 100644 index 00000000..0ba41819 --- /dev/null +++ b/docs/docs/GreaterThanDaysThreshold.md @@ -0,0 +1,108 @@ +# GreaterThanDaysThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value. | [optional] +**Threshold** | Pointer to **int** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to **string** | Element used to express the quantity. This can be an element of time, storage capacity, and the like. | [optional] + +## Methods + +### NewGreaterThanDaysThreshold + +`func NewGreaterThanDaysThreshold() *GreaterThanDaysThreshold` + +NewGreaterThanDaysThreshold instantiates a new GreaterThanDaysThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGreaterThanDaysThresholdWithDefaults + +`func NewGreaterThanDaysThresholdWithDefaults() *GreaterThanDaysThreshold` + +NewGreaterThanDaysThresholdWithDefaults instantiates a new GreaterThanDaysThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOperator + +`func (o *GreaterThanDaysThreshold) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *GreaterThanDaysThreshold) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *GreaterThanDaysThreshold) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *GreaterThanDaysThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *GreaterThanDaysThreshold) GetThreshold() int` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *GreaterThanDaysThreshold) GetThresholdOk() (*int, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *GreaterThanDaysThreshold) SetThreshold(v int)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *GreaterThanDaysThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *GreaterThanDaysThreshold) GetUnits() string` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *GreaterThanDaysThreshold) GetUnitsOk() (*string, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *GreaterThanDaysThreshold) SetUnits(v string)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *GreaterThanDaysThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GreaterThanRawThreshold.md b/docs/docs/GreaterThanRawThreshold.md new file mode 100644 index 00000000..22f15302 --- /dev/null +++ b/docs/docs/GreaterThanRawThreshold.md @@ -0,0 +1,108 @@ +# GreaterThanRawThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value. | [optional] +**Threshold** | Pointer to **int** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**RawMetricUnits**](RawMetricUnits.md) | | [optional] [default to RAWMETRICUNITS_RAW] + +## Methods + +### NewGreaterThanRawThreshold + +`func NewGreaterThanRawThreshold() *GreaterThanRawThreshold` + +NewGreaterThanRawThreshold instantiates a new GreaterThanRawThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGreaterThanRawThresholdWithDefaults + +`func NewGreaterThanRawThresholdWithDefaults() *GreaterThanRawThreshold` + +NewGreaterThanRawThresholdWithDefaults instantiates a new GreaterThanRawThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOperator + +`func (o *GreaterThanRawThreshold) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *GreaterThanRawThreshold) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *GreaterThanRawThreshold) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *GreaterThanRawThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *GreaterThanRawThreshold) GetThreshold() int` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *GreaterThanRawThreshold) GetThresholdOk() (*int, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *GreaterThanRawThreshold) SetThreshold(v int)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *GreaterThanRawThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *GreaterThanRawThreshold) GetUnits() RawMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *GreaterThanRawThreshold) GetUnitsOk() (*RawMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *GreaterThanRawThreshold) SetUnits(v RawMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *GreaterThanRawThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GreaterThanRawThresholdAlertConfigViewForNdsGroup.md b/docs/docs/GreaterThanRawThresholdAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..f938ac7b --- /dev/null +++ b/docs/docs/GreaterThanRawThresholdAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# GreaterThanRawThresholdAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold**](ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]ReplicaSetMatcher**](ReplicaSetMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**GreaterThanRawThreshold**](GreaterThanRawThreshold.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewGreaterThanRawThresholdAlertConfigViewForNdsGroup + +`func NewGreaterThanRawThresholdAlertConfigViewForNdsGroup(eventTypeName ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold, ) *GreaterThanRawThresholdAlertConfigViewForNdsGroup` + +NewGreaterThanRawThresholdAlertConfigViewForNdsGroup instantiates a new GreaterThanRawThresholdAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGreaterThanRawThresholdAlertConfigViewForNdsGroupWithDefaults + +`func NewGreaterThanRawThresholdAlertConfigViewForNdsGroupWithDefaults() *GreaterThanRawThresholdAlertConfigViewForNdsGroup` + +NewGreaterThanRawThresholdAlertConfigViewForNdsGroupWithDefaults instantiates a new GreaterThanRawThresholdAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetEventTypeName() ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetEventTypeName(v ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetMatchers() []ReplicaSetMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetMatchersOk() (*[]ReplicaSetMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetMatchers(v []ReplicaSetMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetThreshold() GreaterThanRawThreshold` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetThresholdOk() (*GreaterThanRawThreshold, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetThreshold(v GreaterThanRawThreshold)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *GreaterThanRawThresholdAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GreaterThanTimeThreshold.md b/docs/docs/GreaterThanTimeThreshold.md new file mode 100644 index 00000000..f2b5d4b1 --- /dev/null +++ b/docs/docs/GreaterThanTimeThreshold.md @@ -0,0 +1,108 @@ +# GreaterThanTimeThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value. | [optional] +**Threshold** | Pointer to **int** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**TimeMetricUnits**](TimeMetricUnits.md) | | [optional] [default to TIMEMETRICUNITS_HOURS] + +## Methods + +### NewGreaterThanTimeThreshold + +`func NewGreaterThanTimeThreshold() *GreaterThanTimeThreshold` + +NewGreaterThanTimeThreshold instantiates a new GreaterThanTimeThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGreaterThanTimeThresholdWithDefaults + +`func NewGreaterThanTimeThresholdWithDefaults() *GreaterThanTimeThreshold` + +NewGreaterThanTimeThresholdWithDefaults instantiates a new GreaterThanTimeThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOperator + +`func (o *GreaterThanTimeThreshold) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *GreaterThanTimeThreshold) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *GreaterThanTimeThreshold) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *GreaterThanTimeThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *GreaterThanTimeThreshold) GetThreshold() int` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *GreaterThanTimeThreshold) GetThresholdOk() (*int, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *GreaterThanTimeThreshold) SetThreshold(v int)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *GreaterThanTimeThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *GreaterThanTimeThreshold) GetUnits() TimeMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *GreaterThanTimeThreshold) GetUnitsOk() (*TimeMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *GreaterThanTimeThreshold) SetUnits(v TimeMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *GreaterThanTimeThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Group.md b/docs/docs/Group.md new file mode 100644 index 00000000..8f13abb5 --- /dev/null +++ b/docs/docs/Group.md @@ -0,0 +1,192 @@ +# Group + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterCount** | **int64** | Quantity of MongoDB Cloud clusters deployed in this project. | [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Name** | **string** | Human-readable label that identifies the project included in the MongoDB Cloud organization. | +**OrgId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs. | +**WithDefaultAlertsSettings** | Pointer to **bool** | Flag that indicates whether to create the project with default alert settings. | [optional] + +## Methods + +### NewGroup + +`func NewGroup(clusterCount int64, created time.Time, name string, orgId string, ) *Group` + +NewGroup instantiates a new Group object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupWithDefaults + +`func NewGroupWithDefaults() *Group` + +NewGroupWithDefaults instantiates a new Group object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterCount + +`func (o *Group) GetClusterCount() int64` + +GetClusterCount returns the ClusterCount field if non-nil, zero value otherwise. + +### GetClusterCountOk + +`func (o *Group) GetClusterCountOk() (*int64, bool)` + +GetClusterCountOk returns a tuple with the ClusterCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterCount + +`func (o *Group) SetClusterCount(v int64)` + +SetClusterCount sets ClusterCount field to given value. + + +### GetCreated + +`func (o *Group) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Group) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Group) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetId + +`func (o *Group) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Group) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Group) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Group) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *Group) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Group) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Group) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Group) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetName + +`func (o *Group) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Group) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Group) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOrgId + +`func (o *Group) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *Group) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *Group) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + + +### GetWithDefaultAlertsSettings + +`func (o *Group) GetWithDefaultAlertsSettings() bool` + +GetWithDefaultAlertsSettings returns the WithDefaultAlertsSettings field if non-nil, zero value otherwise. + +### GetWithDefaultAlertsSettingsOk + +`func (o *Group) GetWithDefaultAlertsSettingsOk() (*bool, bool)` + +GetWithDefaultAlertsSettingsOk returns a tuple with the WithDefaultAlertsSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWithDefaultAlertsSettings + +`func (o *Group) SetWithDefaultAlertsSettings(v bool)` + +SetWithDefaultAlertsSettings sets WithDefaultAlertsSettings field to given value. + +### HasWithDefaultAlertsSettings + +`func (o *Group) HasWithDefaultAlertsSettings() bool` + +HasWithDefaultAlertsSettings returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupInvitation.md b/docs/docs/GroupInvitation.md new file mode 100644 index 00000000..bc9ec5f8 --- /dev/null +++ b/docs/docs/GroupInvitation.md @@ -0,0 +1,264 @@ +# GroupInvitation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**GroupName** | Pointer to **string** | Human-readable label that identifies the project to which you invited the MongoDB Cloud user. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the invitation. | [optional] [readonly] +**InviterUsername** | Pointer to **string** | Email address of the MongoDB Cloud user who sent the invitation. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Roles** | Pointer to **[]string** | One or more organization or project level roles to assign to the MongoDB Cloud user. | [optional] +**Username** | Pointer to **string** | Email address of the MongoDB Cloud user invited to join the project. | [optional] [readonly] + +## Methods + +### NewGroupInvitation + +`func NewGroupInvitation() *GroupInvitation` + +NewGroupInvitation instantiates a new GroupInvitation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupInvitationWithDefaults + +`func NewGroupInvitationWithDefaults() *GroupInvitation` + +NewGroupInvitationWithDefaults instantiates a new GroupInvitation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreatedAt + +`func (o *GroupInvitation) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *GroupInvitation) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *GroupInvitation) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *GroupInvitation) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *GroupInvitation) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *GroupInvitation) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *GroupInvitation) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *GroupInvitation) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetGroupId + +`func (o *GroupInvitation) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *GroupInvitation) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *GroupInvitation) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *GroupInvitation) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetGroupName + +`func (o *GroupInvitation) GetGroupName() string` + +GetGroupName returns the GroupName field if non-nil, zero value otherwise. + +### GetGroupNameOk + +`func (o *GroupInvitation) GetGroupNameOk() (*string, bool)` + +GetGroupNameOk returns a tuple with the GroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupName + +`func (o *GroupInvitation) SetGroupName(v string)` + +SetGroupName sets GroupName field to given value. + +### HasGroupName + +`func (o *GroupInvitation) HasGroupName() bool` + +HasGroupName returns a boolean if a field has been set. + +### GetId + +`func (o *GroupInvitation) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GroupInvitation) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GroupInvitation) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GroupInvitation) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetInviterUsername + +`func (o *GroupInvitation) GetInviterUsername() string` + +GetInviterUsername returns the InviterUsername field if non-nil, zero value otherwise. + +### GetInviterUsernameOk + +`func (o *GroupInvitation) GetInviterUsernameOk() (*string, bool)` + +GetInviterUsernameOk returns a tuple with the InviterUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInviterUsername + +`func (o *GroupInvitation) SetInviterUsername(v string)` + +SetInviterUsername sets InviterUsername field to given value. + +### HasInviterUsername + +`func (o *GroupInvitation) HasInviterUsername() bool` + +HasInviterUsername returns a boolean if a field has been set. + +### GetLinks + +`func (o *GroupInvitation) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *GroupInvitation) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *GroupInvitation) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *GroupInvitation) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetRoles + +`func (o *GroupInvitation) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *GroupInvitation) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *GroupInvitation) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *GroupInvitation) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetUsername + +`func (o *GroupInvitation) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *GroupInvitation) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *GroupInvitation) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *GroupInvitation) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupInvitationRequest.md b/docs/docs/GroupInvitationRequest.md new file mode 100644 index 00000000..6ca1b525 --- /dev/null +++ b/docs/docs/GroupInvitationRequest.md @@ -0,0 +1,82 @@ +# GroupInvitationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Roles** | Pointer to **[]string** | One or more organization or project level roles to assign to the MongoDB Cloud user. | [optional] +**Username** | Pointer to **string** | Email address of the MongoDB Cloud user invited to the specified project. | [optional] + +## Methods + +### NewGroupInvitationRequest + +`func NewGroupInvitationRequest() *GroupInvitationRequest` + +NewGroupInvitationRequest instantiates a new GroupInvitationRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupInvitationRequestWithDefaults + +`func NewGroupInvitationRequestWithDefaults() *GroupInvitationRequest` + +NewGroupInvitationRequestWithDefaults instantiates a new GroupInvitationRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRoles + +`func (o *GroupInvitationRequest) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *GroupInvitationRequest) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *GroupInvitationRequest) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *GroupInvitationRequest) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetUsername + +`func (o *GroupInvitationRequest) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *GroupInvitationRequest) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *GroupInvitationRequest) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *GroupInvitationRequest) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupInvitationUpdateRequest.md b/docs/docs/GroupInvitationUpdateRequest.md new file mode 100644 index 00000000..803e2fa2 --- /dev/null +++ b/docs/docs/GroupInvitationUpdateRequest.md @@ -0,0 +1,56 @@ +# GroupInvitationUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Roles** | Pointer to **[]string** | One or more organization or project level roles to assign to the MongoDB Cloud user. | [optional] + +## Methods + +### NewGroupInvitationUpdateRequest + +`func NewGroupInvitationUpdateRequest() *GroupInvitationUpdateRequest` + +NewGroupInvitationUpdateRequest instantiates a new GroupInvitationUpdateRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupInvitationUpdateRequestWithDefaults + +`func NewGroupInvitationUpdateRequestWithDefaults() *GroupInvitationUpdateRequest` + +NewGroupInvitationUpdateRequestWithDefaults instantiates a new GroupInvitationUpdateRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRoles + +`func (o *GroupInvitationUpdateRequest) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *GroupInvitationUpdateRequest) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *GroupInvitationUpdateRequest) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *GroupInvitationUpdateRequest) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupMaintenanceWindow.md b/docs/docs/GroupMaintenanceWindow.md new file mode 100644 index 00000000..a2a04b90 --- /dev/null +++ b/docs/docs/GroupMaintenanceWindow.md @@ -0,0 +1,124 @@ +# GroupMaintenanceWindow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoDeferOnceEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them. | [optional] +**DayOfWeek** | **int** | One-based integer that represents the day of the week that the maintenance window starts. | Value | Day of Week | |---|---| | `1` | Sunday | | `2` | Monday | | `3` | Tuesday | | `4` | Wednesday | | `5` | Thursday | | `6` | Friday | | `7` | Saturday | | +**HourOfDay** | **int** | Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon. | +**StartASAP** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance. | [optional] + +## Methods + +### NewGroupMaintenanceWindow + +`func NewGroupMaintenanceWindow(dayOfWeek int, hourOfDay int, ) *GroupMaintenanceWindow` + +NewGroupMaintenanceWindow instantiates a new GroupMaintenanceWindow object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupMaintenanceWindowWithDefaults + +`func NewGroupMaintenanceWindowWithDefaults() *GroupMaintenanceWindow` + +NewGroupMaintenanceWindowWithDefaults instantiates a new GroupMaintenanceWindow object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoDeferOnceEnabled + +`func (o *GroupMaintenanceWindow) GetAutoDeferOnceEnabled() bool` + +GetAutoDeferOnceEnabled returns the AutoDeferOnceEnabled field if non-nil, zero value otherwise. + +### GetAutoDeferOnceEnabledOk + +`func (o *GroupMaintenanceWindow) GetAutoDeferOnceEnabledOk() (*bool, bool)` + +GetAutoDeferOnceEnabledOk returns a tuple with the AutoDeferOnceEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoDeferOnceEnabled + +`func (o *GroupMaintenanceWindow) SetAutoDeferOnceEnabled(v bool)` + +SetAutoDeferOnceEnabled sets AutoDeferOnceEnabled field to given value. + +### HasAutoDeferOnceEnabled + +`func (o *GroupMaintenanceWindow) HasAutoDeferOnceEnabled() bool` + +HasAutoDeferOnceEnabled returns a boolean if a field has been set. + +### GetDayOfWeek + +`func (o *GroupMaintenanceWindow) GetDayOfWeek() int` + +GetDayOfWeek returns the DayOfWeek field if non-nil, zero value otherwise. + +### GetDayOfWeekOk + +`func (o *GroupMaintenanceWindow) GetDayOfWeekOk() (*int, bool)` + +GetDayOfWeekOk returns a tuple with the DayOfWeek field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDayOfWeek + +`func (o *GroupMaintenanceWindow) SetDayOfWeek(v int)` + +SetDayOfWeek sets DayOfWeek field to given value. + + +### GetHourOfDay + +`func (o *GroupMaintenanceWindow) GetHourOfDay() int` + +GetHourOfDay returns the HourOfDay field if non-nil, zero value otherwise. + +### GetHourOfDayOk + +`func (o *GroupMaintenanceWindow) GetHourOfDayOk() (*int, bool)` + +GetHourOfDayOk returns a tuple with the HourOfDay field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHourOfDay + +`func (o *GroupMaintenanceWindow) SetHourOfDay(v int)` + +SetHourOfDay sets HourOfDay field to given value. + + +### GetStartASAP + +`func (o *GroupMaintenanceWindow) GetStartASAP() bool` + +GetStartASAP returns the StartASAP field if non-nil, zero value otherwise. + +### GetStartASAPOk + +`func (o *GroupMaintenanceWindow) GetStartASAPOk() (*bool, bool)` + +GetStartASAPOk returns a tuple with the StartASAP field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartASAP + +`func (o *GroupMaintenanceWindow) SetStartASAP(v bool)` + +SetStartASAP sets StartASAP field to given value. + +### HasStartASAP + +`func (o *GroupMaintenanceWindow) HasStartASAP() bool` + +HasStartASAP returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupName.md b/docs/docs/GroupName.md new file mode 100644 index 00000000..4edac2a5 --- /dev/null +++ b/docs/docs/GroupName.md @@ -0,0 +1,56 @@ +# GroupName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Human-readable label that identifies the project included in the MongoDB Cloud organization. | [optional] + +## Methods + +### NewGroupName + +`func NewGroupName() *GroupName` + +NewGroupName instantiates a new GroupName object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupNameWithDefaults + +`func NewGroupNameWithDefaults() *GroupName` + +NewGroupNameWithDefaults instantiates a new GroupName object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *GroupName) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GroupName) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GroupName) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *GroupName) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupNotification.md b/docs/docs/GroupNotification.md new file mode 100644 index 00000000..55aa6161 --- /dev/null +++ b/docs/docs/GroupNotification.md @@ -0,0 +1,181 @@ +# GroupNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**EmailEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**Roles** | Pointer to **[]string** | List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role. | [optional] +**SmsEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewGroupNotification + +`func NewGroupNotification(typeName string, ) *GroupNotification` + +NewGroupNotification instantiates a new GroupNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupNotificationWithDefaults + +`func NewGroupNotificationWithDefaults() *GroupNotification` + +NewGroupNotificationWithDefaults instantiates a new GroupNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *GroupNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *GroupNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *GroupNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *GroupNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetEmailEnabled + +`func (o *GroupNotification) GetEmailEnabled() bool` + +GetEmailEnabled returns the EmailEnabled field if non-nil, zero value otherwise. + +### GetEmailEnabledOk + +`func (o *GroupNotification) GetEmailEnabledOk() (*bool, bool)` + +GetEmailEnabledOk returns a tuple with the EmailEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEnabled + +`func (o *GroupNotification) SetEmailEnabled(v bool)` + +SetEmailEnabled sets EmailEnabled field to given value. + +### HasEmailEnabled + +`func (o *GroupNotification) HasEmailEnabled() bool` + +HasEmailEnabled returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *GroupNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *GroupNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *GroupNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *GroupNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetRoles + +`func (o *GroupNotification) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *GroupNotification) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *GroupNotification) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *GroupNotification) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetSmsEnabled + +`func (o *GroupNotification) GetSmsEnabled() bool` + +GetSmsEnabled returns the SmsEnabled field if non-nil, zero value otherwise. + +### GetSmsEnabledOk + +`func (o *GroupNotification) GetSmsEnabledOk() (*bool, bool)` + +GetSmsEnabledOk returns a tuple with the SmsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSmsEnabled + +`func (o *GroupNotification) SetSmsEnabled(v bool)` + +SetSmsEnabled sets SmsEnabled field to given value. + +### HasSmsEnabled + +`func (o *GroupNotification) HasSmsEnabled() bool` + +HasSmsEnabled returns a boolean if a field has been set. + +### GetTypeName + +`func (o *GroupNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *GroupNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *GroupNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupPaginatedEvent.md b/docs/docs/GroupPaginatedEvent.md new file mode 100644 index 00000000..8ae281f5 --- /dev/null +++ b/docs/docs/GroupPaginatedEvent.md @@ -0,0 +1,108 @@ +# GroupPaginatedEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]EventViewForNdsGroup**](EventViewForNdsGroup.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response if **includeCount** query param is true. | [optional] [readonly] + +## Methods + +### NewGroupPaginatedEvent + +`func NewGroupPaginatedEvent() *GroupPaginatedEvent` + +NewGroupPaginatedEvent instantiates a new GroupPaginatedEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupPaginatedEventWithDefaults + +`func NewGroupPaginatedEventWithDefaults() *GroupPaginatedEvent` + +NewGroupPaginatedEventWithDefaults instantiates a new GroupPaginatedEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *GroupPaginatedEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *GroupPaginatedEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *GroupPaginatedEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *GroupPaginatedEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *GroupPaginatedEvent) GetResults() []EventViewForNdsGroup` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *GroupPaginatedEvent) GetResultsOk() (*[]EventViewForNdsGroup, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *GroupPaginatedEvent) SetResults(v []EventViewForNdsGroup)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *GroupPaginatedEvent) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *GroupPaginatedEvent) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *GroupPaginatedEvent) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *GroupPaginatedEvent) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *GroupPaginatedEvent) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/GroupSettings.md b/docs/docs/GroupSettings.md new file mode 100644 index 00000000..ba3e4df0 --- /dev/null +++ b/docs/docs/GroupSettings.md @@ -0,0 +1,186 @@ +# GroupSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsCollectDatabaseSpecificsStatisticsEnabled** | Pointer to **bool** | Flag that indicates whether to collect database-specific metrics for the specified project. | [optional] +**IsDataExplorerEnabled** | Pointer to **bool** | Flag that indicates whether to enable the Data Explorer for the specified project. | [optional] +**IsExtendedStorageSizesEnabled** | Pointer to **bool** | Flag that indicates whether to enable extended storage sizes for the specified project. | [optional] +**IsPerformanceAdvisorEnabled** | Pointer to **bool** | Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project. | [optional] +**IsRealtimePerformancePanelEnabled** | Pointer to **bool** | Flag that indicates whether to enable the Real Time Performance Panel for the specified project. | [optional] +**IsSchemaAdvisorEnabled** | Pointer to **bool** | Flag that indicates whether to enable the Schema Advisor for the specified project. | [optional] + +## Methods + +### NewGroupSettings + +`func NewGroupSettings() *GroupSettings` + +NewGroupSettings instantiates a new GroupSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGroupSettingsWithDefaults + +`func NewGroupSettingsWithDefaults() *GroupSettings` + +NewGroupSettingsWithDefaults instantiates a new GroupSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIsCollectDatabaseSpecificsStatisticsEnabled + +`func (o *GroupSettings) GetIsCollectDatabaseSpecificsStatisticsEnabled() bool` + +GetIsCollectDatabaseSpecificsStatisticsEnabled returns the IsCollectDatabaseSpecificsStatisticsEnabled field if non-nil, zero value otherwise. + +### GetIsCollectDatabaseSpecificsStatisticsEnabledOk + +`func (o *GroupSettings) GetIsCollectDatabaseSpecificsStatisticsEnabledOk() (*bool, bool)` + +GetIsCollectDatabaseSpecificsStatisticsEnabledOk returns a tuple with the IsCollectDatabaseSpecificsStatisticsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsCollectDatabaseSpecificsStatisticsEnabled + +`func (o *GroupSettings) SetIsCollectDatabaseSpecificsStatisticsEnabled(v bool)` + +SetIsCollectDatabaseSpecificsStatisticsEnabled sets IsCollectDatabaseSpecificsStatisticsEnabled field to given value. + +### HasIsCollectDatabaseSpecificsStatisticsEnabled + +`func (o *GroupSettings) HasIsCollectDatabaseSpecificsStatisticsEnabled() bool` + +HasIsCollectDatabaseSpecificsStatisticsEnabled returns a boolean if a field has been set. + +### GetIsDataExplorerEnabled + +`func (o *GroupSettings) GetIsDataExplorerEnabled() bool` + +GetIsDataExplorerEnabled returns the IsDataExplorerEnabled field if non-nil, zero value otherwise. + +### GetIsDataExplorerEnabledOk + +`func (o *GroupSettings) GetIsDataExplorerEnabledOk() (*bool, bool)` + +GetIsDataExplorerEnabledOk returns a tuple with the IsDataExplorerEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDataExplorerEnabled + +`func (o *GroupSettings) SetIsDataExplorerEnabled(v bool)` + +SetIsDataExplorerEnabled sets IsDataExplorerEnabled field to given value. + +### HasIsDataExplorerEnabled + +`func (o *GroupSettings) HasIsDataExplorerEnabled() bool` + +HasIsDataExplorerEnabled returns a boolean if a field has been set. + +### GetIsExtendedStorageSizesEnabled + +`func (o *GroupSettings) GetIsExtendedStorageSizesEnabled() bool` + +GetIsExtendedStorageSizesEnabled returns the IsExtendedStorageSizesEnabled field if non-nil, zero value otherwise. + +### GetIsExtendedStorageSizesEnabledOk + +`func (o *GroupSettings) GetIsExtendedStorageSizesEnabledOk() (*bool, bool)` + +GetIsExtendedStorageSizesEnabledOk returns a tuple with the IsExtendedStorageSizesEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsExtendedStorageSizesEnabled + +`func (o *GroupSettings) SetIsExtendedStorageSizesEnabled(v bool)` + +SetIsExtendedStorageSizesEnabled sets IsExtendedStorageSizesEnabled field to given value. + +### HasIsExtendedStorageSizesEnabled + +`func (o *GroupSettings) HasIsExtendedStorageSizesEnabled() bool` + +HasIsExtendedStorageSizesEnabled returns a boolean if a field has been set. + +### GetIsPerformanceAdvisorEnabled + +`func (o *GroupSettings) GetIsPerformanceAdvisorEnabled() bool` + +GetIsPerformanceAdvisorEnabled returns the IsPerformanceAdvisorEnabled field if non-nil, zero value otherwise. + +### GetIsPerformanceAdvisorEnabledOk + +`func (o *GroupSettings) GetIsPerformanceAdvisorEnabledOk() (*bool, bool)` + +GetIsPerformanceAdvisorEnabledOk returns a tuple with the IsPerformanceAdvisorEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPerformanceAdvisorEnabled + +`func (o *GroupSettings) SetIsPerformanceAdvisorEnabled(v bool)` + +SetIsPerformanceAdvisorEnabled sets IsPerformanceAdvisorEnabled field to given value. + +### HasIsPerformanceAdvisorEnabled + +`func (o *GroupSettings) HasIsPerformanceAdvisorEnabled() bool` + +HasIsPerformanceAdvisorEnabled returns a boolean if a field has been set. + +### GetIsRealtimePerformancePanelEnabled + +`func (o *GroupSettings) GetIsRealtimePerformancePanelEnabled() bool` + +GetIsRealtimePerformancePanelEnabled returns the IsRealtimePerformancePanelEnabled field if non-nil, zero value otherwise. + +### GetIsRealtimePerformancePanelEnabledOk + +`func (o *GroupSettings) GetIsRealtimePerformancePanelEnabledOk() (*bool, bool)` + +GetIsRealtimePerformancePanelEnabledOk returns a tuple with the IsRealtimePerformancePanelEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsRealtimePerformancePanelEnabled + +`func (o *GroupSettings) SetIsRealtimePerformancePanelEnabled(v bool)` + +SetIsRealtimePerformancePanelEnabled sets IsRealtimePerformancePanelEnabled field to given value. + +### HasIsRealtimePerformancePanelEnabled + +`func (o *GroupSettings) HasIsRealtimePerformancePanelEnabled() bool` + +HasIsRealtimePerformancePanelEnabled returns a boolean if a field has been set. + +### GetIsSchemaAdvisorEnabled + +`func (o *GroupSettings) GetIsSchemaAdvisorEnabled() bool` + +GetIsSchemaAdvisorEnabled returns the IsSchemaAdvisorEnabled field if non-nil, zero value otherwise. + +### GetIsSchemaAdvisorEnabledOk + +`func (o *GroupSettings) GetIsSchemaAdvisorEnabledOk() (*bool, bool)` + +GetIsSchemaAdvisorEnabledOk returns a tuple with the IsSchemaAdvisorEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSchemaAdvisorEnabled + +`func (o *GroupSettings) SetIsSchemaAdvisorEnabled(v bool)` + +SetIsSchemaAdvisorEnabled sets IsSchemaAdvisorEnabled field to given value. + +### HasIsSchemaAdvisorEnabled + +`func (o *GroupSettings) HasIsSchemaAdvisorEnabled() bool` + +HasIsSchemaAdvisorEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HardwareSpec.md b/docs/docs/HardwareSpec.md new file mode 100644 index 00000000..d4304186 --- /dev/null +++ b/docs/docs/HardwareSpec.md @@ -0,0 +1,134 @@ +# HardwareSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DiskIOPS** | Pointer to **int** | Target throughput desired for storage attached to your AWS-provisioned cluster. Change this parameter only if you: - set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"AWS\"`. - set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M30\"` or greater not including `Mxx_NVME` tiers. The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. This parameter defaults to the cluster tier's standard IOPS value. Changing this value impacts cluster cost. MongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets. - Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1. - Instance sizes greater than `M40` have a ratio of 120:1. | [optional] +**EbsVolumeType** | Pointer to **string** | Type of storage you want to attach to your AWS-provisioned cluster. - `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. - `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. | [optional] [default to "STANDARD"] +**InstanceSize** | Pointer to **string** | Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. | [optional] +**NodeCount** | Pointer to **int** | Number of nodes of the given type for MongoDB Cloud to deploy to the region. | [optional] + +## Methods + +### NewHardwareSpec + +`func NewHardwareSpec() *HardwareSpec` + +NewHardwareSpec instantiates a new HardwareSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHardwareSpecWithDefaults + +`func NewHardwareSpecWithDefaults() *HardwareSpec` + +NewHardwareSpecWithDefaults instantiates a new HardwareSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDiskIOPS + +`func (o *HardwareSpec) GetDiskIOPS() int` + +GetDiskIOPS returns the DiskIOPS field if non-nil, zero value otherwise. + +### GetDiskIOPSOk + +`func (o *HardwareSpec) GetDiskIOPSOk() (*int, bool)` + +GetDiskIOPSOk returns a tuple with the DiskIOPS field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskIOPS + +`func (o *HardwareSpec) SetDiskIOPS(v int)` + +SetDiskIOPS sets DiskIOPS field to given value. + +### HasDiskIOPS + +`func (o *HardwareSpec) HasDiskIOPS() bool` + +HasDiskIOPS returns a boolean if a field has been set. + +### GetEbsVolumeType + +`func (o *HardwareSpec) GetEbsVolumeType() string` + +GetEbsVolumeType returns the EbsVolumeType field if non-nil, zero value otherwise. + +### GetEbsVolumeTypeOk + +`func (o *HardwareSpec) GetEbsVolumeTypeOk() (*string, bool)` + +GetEbsVolumeTypeOk returns a tuple with the EbsVolumeType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEbsVolumeType + +`func (o *HardwareSpec) SetEbsVolumeType(v string)` + +SetEbsVolumeType sets EbsVolumeType field to given value. + +### HasEbsVolumeType + +`func (o *HardwareSpec) HasEbsVolumeType() bool` + +HasEbsVolumeType returns a boolean if a field has been set. + +### GetInstanceSize + +`func (o *HardwareSpec) GetInstanceSize() string` + +GetInstanceSize returns the InstanceSize field if non-nil, zero value otherwise. + +### GetInstanceSizeOk + +`func (o *HardwareSpec) GetInstanceSizeOk() (*string, bool)` + +GetInstanceSizeOk returns a tuple with the InstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSize + +`func (o *HardwareSpec) SetInstanceSize(v string)` + +SetInstanceSize sets InstanceSize field to given value. + +### HasInstanceSize + +`func (o *HardwareSpec) HasInstanceSize() bool` + +HasInstanceSize returns a boolean if a field has been set. + +### GetNodeCount + +`func (o *HardwareSpec) GetNodeCount() int` + +GetNodeCount returns the NodeCount field if non-nil, zero value otherwise. + +### GetNodeCountOk + +`func (o *HardwareSpec) GetNodeCountOk() (*int, bool)` + +GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNodeCount + +`func (o *HardwareSpec) SetNodeCount(v int)` + +SetNodeCount sets NodeCount field to given value. + +### HasNodeCount + +`func (o *HardwareSpec) HasNodeCount() bool` + +HasNodeCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HipChatNotification.md b/docs/docs/HipChatNotification.md new file mode 100644 index 00000000..4298508b --- /dev/null +++ b/docs/docs/HipChatNotification.md @@ -0,0 +1,155 @@ +# HipChatNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**NotificationToken** | Pointer to **string** | HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**RoomName** | Pointer to **string** | HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewHipChatNotification + +`func NewHipChatNotification(typeName string, ) *HipChatNotification` + +NewHipChatNotification instantiates a new HipChatNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHipChatNotificationWithDefaults + +`func NewHipChatNotificationWithDefaults() *HipChatNotification` + +NewHipChatNotificationWithDefaults instantiates a new HipChatNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *HipChatNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *HipChatNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *HipChatNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *HipChatNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *HipChatNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *HipChatNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *HipChatNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *HipChatNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetNotificationToken + +`func (o *HipChatNotification) GetNotificationToken() string` + +GetNotificationToken returns the NotificationToken field if non-nil, zero value otherwise. + +### GetNotificationTokenOk + +`func (o *HipChatNotification) GetNotificationTokenOk() (*string, bool)` + +GetNotificationTokenOk returns a tuple with the NotificationToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationToken + +`func (o *HipChatNotification) SetNotificationToken(v string)` + +SetNotificationToken sets NotificationToken field to given value. + +### HasNotificationToken + +`func (o *HipChatNotification) HasNotificationToken() bool` + +HasNotificationToken returns a boolean if a field has been set. + +### GetRoomName + +`func (o *HipChatNotification) GetRoomName() string` + +GetRoomName returns the RoomName field if non-nil, zero value otherwise. + +### GetRoomNameOk + +`func (o *HipChatNotification) GetRoomNameOk() (*string, bool)` + +GetRoomNameOk returns a tuple with the RoomName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoomName + +`func (o *HipChatNotification) SetRoomName(v string)` + +SetRoomName sets RoomName field to given value. + +### HasRoomName + +`func (o *HipChatNotification) HasRoomName() bool` + +HasRoomName returns a boolean if a field has been set. + +### GetTypeName + +`func (o *HipChatNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *HipChatNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *HipChatNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostAlertConfigViewForNdsGroup.md b/docs/docs/HostAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..fef04a06 --- /dev/null +++ b/docs/docs/HostAlertConfigViewForNdsGroup.md @@ -0,0 +1,259 @@ +# HostAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**HostEventTypeViewForNdsGroupAlertable**](HostEventTypeViewForNdsGroupAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]HostMatcher**](HostMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewHostAlertConfigViewForNdsGroup + +`func NewHostAlertConfigViewForNdsGroup(eventTypeName HostEventTypeViewForNdsGroupAlertable, ) *HostAlertConfigViewForNdsGroup` + +NewHostAlertConfigViewForNdsGroup instantiates a new HostAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostAlertConfigViewForNdsGroupWithDefaults + +`func NewHostAlertConfigViewForNdsGroupWithDefaults() *HostAlertConfigViewForNdsGroup` + +NewHostAlertConfigViewForNdsGroupWithDefaults instantiates a new HostAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *HostAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *HostAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *HostAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *HostAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *HostAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *HostAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *HostAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *HostAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *HostAlertConfigViewForNdsGroup) GetEventTypeName() HostEventTypeViewForNdsGroupAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *HostAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*HostEventTypeViewForNdsGroupAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *HostAlertConfigViewForNdsGroup) SetEventTypeName(v HostEventTypeViewForNdsGroupAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *HostAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *HostAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *HostAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *HostAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *HostAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HostAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HostAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *HostAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *HostAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *HostAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *HostAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *HostAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *HostAlertConfigViewForNdsGroup) GetMatchers() []HostMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *HostAlertConfigViewForNdsGroup) GetMatchersOk() (*[]HostMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *HostAlertConfigViewForNdsGroup) SetMatchers(v []HostMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *HostAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *HostAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *HostAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *HostAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *HostAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *HostAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *HostAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *HostAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *HostAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostAlertViewForNdsGroup.md b/docs/docs/HostAlertViewForNdsGroup.md new file mode 100644 index 00000000..39d53a0e --- /dev/null +++ b/docs/docs/HostAlertViewForNdsGroup.md @@ -0,0 +1,437 @@ +# HostAlertViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**HostEventTypeViewForNdsGroupAlertable**](HostEventTypeViewForNdsGroupAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewHostAlertViewForNdsGroup + +`func NewHostAlertViewForNdsGroup(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName HostEventTypeViewForNdsGroupAlertable, id string, status string, updated time.Time, ) *HostAlertViewForNdsGroup` + +NewHostAlertViewForNdsGroup instantiates a new HostAlertViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostAlertViewForNdsGroupWithDefaults + +`func NewHostAlertViewForNdsGroupWithDefaults() *HostAlertViewForNdsGroup` + +NewHostAlertViewForNdsGroupWithDefaults instantiates a new HostAlertViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *HostAlertViewForNdsGroup) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *HostAlertViewForNdsGroup) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *HostAlertViewForNdsGroup) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *HostAlertViewForNdsGroup) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *HostAlertViewForNdsGroup) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *HostAlertViewForNdsGroup) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *HostAlertViewForNdsGroup) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *HostAlertViewForNdsGroup) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *HostAlertViewForNdsGroup) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *HostAlertViewForNdsGroup) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *HostAlertViewForNdsGroup) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *HostAlertViewForNdsGroup) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *HostAlertViewForNdsGroup) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *HostAlertViewForNdsGroup) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *HostAlertViewForNdsGroup) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *HostAlertViewForNdsGroup) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *HostAlertViewForNdsGroup) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *HostAlertViewForNdsGroup) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *HostAlertViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *HostAlertViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *HostAlertViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *HostAlertViewForNdsGroup) GetEventTypeName() HostEventTypeViewForNdsGroupAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *HostAlertViewForNdsGroup) GetEventTypeNameOk() (*HostEventTypeViewForNdsGroupAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *HostAlertViewForNdsGroup) SetEventTypeName(v HostEventTypeViewForNdsGroupAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *HostAlertViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *HostAlertViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *HostAlertViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *HostAlertViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *HostAlertViewForNdsGroup) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *HostAlertViewForNdsGroup) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *HostAlertViewForNdsGroup) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *HostAlertViewForNdsGroup) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetId + +`func (o *HostAlertViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HostAlertViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HostAlertViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *HostAlertViewForNdsGroup) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *HostAlertViewForNdsGroup) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *HostAlertViewForNdsGroup) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *HostAlertViewForNdsGroup) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *HostAlertViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *HostAlertViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *HostAlertViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *HostAlertViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *HostAlertViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *HostAlertViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *HostAlertViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *HostAlertViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *HostAlertViewForNdsGroup) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *HostAlertViewForNdsGroup) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *HostAlertViewForNdsGroup) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *HostAlertViewForNdsGroup) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetResolved + +`func (o *HostAlertViewForNdsGroup) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *HostAlertViewForNdsGroup) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *HostAlertViewForNdsGroup) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *HostAlertViewForNdsGroup) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *HostAlertViewForNdsGroup) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *HostAlertViewForNdsGroup) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *HostAlertViewForNdsGroup) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *HostAlertViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *HostAlertViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *HostAlertViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostEventTypeViewForNdsGroup.md b/docs/docs/HostEventTypeViewForNdsGroup.md new file mode 100644 index 00000000..003262a5 --- /dev/null +++ b/docs/docs/HostEventTypeViewForNdsGroup.md @@ -0,0 +1,33 @@ +# HostEventTypeViewForNdsGroup + +## Enum + + +* `AUTO_CREATED_INDEX_AUDIT` (value: `"AUTO_CREATED_INDEX_AUDIT"`) + +* `ATTEMPT_KILLOP_AUDIT` (value: `"ATTEMPT_KILLOP_AUDIT"`) + +* `ATTEMPT_KILLSESSION_AUDIT` (value: `"ATTEMPT_KILLSESSION_AUDIT"`) + +* `HOST_UP` (value: `"HOST_UP"`) + +* `HOST_DOWN` (value: `"HOST_DOWN"`) + +* `HOST_HAS_INDEX_SUGGESTIONS` (value: `"HOST_HAS_INDEX_SUGGESTIONS"`) + +* `HOST_MONGOT_RECOVERED_OOM` (value: `"HOST_MONGOT_RECOVERED_OOM"`) + +* `HOST_MONGOT_CRASHING_OOM` (value: `"HOST_MONGOT_CRASHING_OOM"`) + +* `HOST_DISK_SPACE_SUFFICIENT_FOR_SEARCH_INDEX_REBUILD` (value: `"HOST_DISK_SPACE_SUFFICIENT_FOR_SEARCH_INDEX_REBUILD"`) + +* `HOST_ENOUGH_DISK_SPACE` (value: `"HOST_ENOUGH_DISK_SPACE"`) + +* `HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD` (value: `"HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD"`) + +* `HOST_NOT_ENOUGH_DISK_SPACE` (value: `"HOST_NOT_ENOUGH_DISK_SPACE"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostEventTypeViewForNdsGroupAlertable.md b/docs/docs/HostEventTypeViewForNdsGroupAlertable.md new file mode 100644 index 00000000..fe6925a8 --- /dev/null +++ b/docs/docs/HostEventTypeViewForNdsGroupAlertable.md @@ -0,0 +1,19 @@ +# HostEventTypeViewForNdsGroupAlertable + +## Enum + + +* `DOWN` (value: `"HOST_DOWN"`) + +* `HAS_INDEX_SUGGESTIONS` (value: `"HOST_HAS_INDEX_SUGGESTIONS"`) + +* `MONGOT_CRASHING_OOM` (value: `"HOST_MONGOT_CRASHING_OOM"`) + +* `DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD` (value: `"HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD"`) + +* `NOT_ENOUGH_DISK_SPACE` (value: `"HOST_NOT_ENOUGH_DISK_SPACE"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostEventViewForNdsGroup.md b/docs/docs/HostEventViewForNdsGroup.md new file mode 100644 index 00000000..bddd627d --- /dev/null +++ b/docs/docs/HostEventViewForNdsGroup.md @@ -0,0 +1,431 @@ +# HostEventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**HostEventTypeViewForNdsGroup**](HostEventTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewHostEventViewForNdsGroup + +`func NewHostEventViewForNdsGroup(created time.Time, eventTypeName HostEventTypeViewForNdsGroup, id string, ) *HostEventViewForNdsGroup` + +NewHostEventViewForNdsGroup instantiates a new HostEventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostEventViewForNdsGroupWithDefaults + +`func NewHostEventViewForNdsGroupWithDefaults() *HostEventViewForNdsGroup` + +NewHostEventViewForNdsGroupWithDefaults instantiates a new HostEventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *HostEventViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *HostEventViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *HostEventViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *HostEventViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *HostEventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *HostEventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *HostEventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *HostEventViewForNdsGroup) GetEventTypeName() HostEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *HostEventViewForNdsGroup) GetEventTypeNameOk() (*HostEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *HostEventViewForNdsGroup) SetEventTypeName(v HostEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *HostEventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *HostEventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *HostEventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *HostEventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *HostEventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HostEventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HostEventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *HostEventViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *HostEventViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *HostEventViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *HostEventViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *HostEventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *HostEventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *HostEventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *HostEventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *HostEventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *HostEventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *HostEventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *HostEventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPort + +`func (o *HostEventViewForNdsGroup) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *HostEventViewForNdsGroup) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *HostEventViewForNdsGroup) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *HostEventViewForNdsGroup) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *HostEventViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *HostEventViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *HostEventViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *HostEventViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *HostEventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *HostEventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *HostEventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *HostEventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *HostEventViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *HostEventViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *HostEventViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *HostEventViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *HostEventViewForNdsGroup) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *HostEventViewForNdsGroup) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *HostEventViewForNdsGroup) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *HostEventViewForNdsGroup) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *HostEventViewForNdsGroup) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *HostEventViewForNdsGroup) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *HostEventViewForNdsGroup) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *HostEventViewForNdsGroup) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetUserId + +`func (o *HostEventViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *HostEventViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *HostEventViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *HostEventViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *HostEventViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *HostEventViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *HostEventViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *HostEventViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMatcher.md b/docs/docs/HostMatcher.md new file mode 100644 index 00000000..36579ab5 --- /dev/null +++ b/docs/docs/HostMatcher.md @@ -0,0 +1,108 @@ +# HostMatcher + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FieldName** | Pointer to [**HostMatcherField**](HostMatcherField.md) | | [optional] +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value against **matcher[n].value**. | [optional] +**Value** | Pointer to [**MatcherHostType**](MatcherHostType.md) | | [optional] + +## Methods + +### NewHostMatcher + +`func NewHostMatcher() *HostMatcher` + +NewHostMatcher instantiates a new HostMatcher object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostMatcherWithDefaults + +`func NewHostMatcherWithDefaults() *HostMatcher` + +NewHostMatcherWithDefaults instantiates a new HostMatcher object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFieldName + +`func (o *HostMatcher) GetFieldName() HostMatcherField` + +GetFieldName returns the FieldName field if non-nil, zero value otherwise. + +### GetFieldNameOk + +`func (o *HostMatcher) GetFieldNameOk() (*HostMatcherField, bool)` + +GetFieldNameOk returns a tuple with the FieldName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFieldName + +`func (o *HostMatcher) SetFieldName(v HostMatcherField)` + +SetFieldName sets FieldName field to given value. + +### HasFieldName + +`func (o *HostMatcher) HasFieldName() bool` + +HasFieldName returns a boolean if a field has been set. + +### GetOperator + +`func (o *HostMatcher) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *HostMatcher) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *HostMatcher) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *HostMatcher) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetValue + +`func (o *HostMatcher) GetValue() MatcherHostType` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *HostMatcher) GetValueOk() (*MatcherHostType, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *HostMatcher) SetValue(v MatcherHostType)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *HostMatcher) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMatcherField.md b/docs/docs/HostMatcherField.md new file mode 100644 index 00000000..024baae2 --- /dev/null +++ b/docs/docs/HostMatcherField.md @@ -0,0 +1,19 @@ +# HostMatcherField + +## Enum + + +* `TYPE_NAME` (value: `"TYPE_NAME"`) + +* `HOSTNAME` (value: `"HOSTNAME"`) + +* `PORT` (value: `"PORT"`) + +* `HOSTNAME_AND_PORT` (value: `"HOSTNAME_AND_PORT"`) + +* `REPLICA_SET_NAME` (value: `"REPLICA_SET_NAME"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMetricAlert.md b/docs/docs/HostMetricAlert.md new file mode 100644 index 00000000..b52a906b --- /dev/null +++ b/docs/docs/HostMetricAlert.md @@ -0,0 +1,489 @@ +# HostMetricAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**NumberMetricValue**](NumberMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventTypeViewAlertable**](HostMetricEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see <a href=\"https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types\" target=\"_blank\">Host Metrics</a>. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href=\"https://dochub.mongodb.org/core/alert-config-serverless-measurements\" target=\"_blank\">Serverless Measurements</a>. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewHostMetricAlert + +`func NewHostMetricAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName HostMetricEventTypeViewAlertable, id string, status string, updated time.Time, ) *HostMetricAlert` + +NewHostMetricAlert instantiates a new HostMetricAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostMetricAlertWithDefaults + +`func NewHostMetricAlertWithDefaults() *HostMetricAlert` + +NewHostMetricAlertWithDefaults instantiates a new HostMetricAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *HostMetricAlert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *HostMetricAlert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *HostMetricAlert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *HostMetricAlert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *HostMetricAlert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *HostMetricAlert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *HostMetricAlert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *HostMetricAlert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *HostMetricAlert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *HostMetricAlert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *HostMetricAlert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *HostMetricAlert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *HostMetricAlert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *HostMetricAlert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *HostMetricAlert) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *HostMetricAlert) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *HostMetricAlert) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *HostMetricAlert) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *HostMetricAlert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *HostMetricAlert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *HostMetricAlert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *HostMetricAlert) GetCurrentValue() NumberMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *HostMetricAlert) GetCurrentValueOk() (*NumberMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *HostMetricAlert) SetCurrentValue(v NumberMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *HostMetricAlert) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *HostMetricAlert) GetEventTypeName() HostMetricEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *HostMetricAlert) GetEventTypeNameOk() (*HostMetricEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *HostMetricAlert) SetEventTypeName(v HostMetricEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *HostMetricAlert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *HostMetricAlert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *HostMetricAlert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *HostMetricAlert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *HostMetricAlert) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *HostMetricAlert) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *HostMetricAlert) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *HostMetricAlert) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetId + +`func (o *HostMetricAlert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HostMetricAlert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HostMetricAlert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *HostMetricAlert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *HostMetricAlert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *HostMetricAlert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *HostMetricAlert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *HostMetricAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *HostMetricAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *HostMetricAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *HostMetricAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *HostMetricAlert) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *HostMetricAlert) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *HostMetricAlert) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *HostMetricAlert) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *HostMetricAlert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *HostMetricAlert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *HostMetricAlert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *HostMetricAlert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *HostMetricAlert) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *HostMetricAlert) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *HostMetricAlert) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *HostMetricAlert) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetResolved + +`func (o *HostMetricAlert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *HostMetricAlert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *HostMetricAlert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *HostMetricAlert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *HostMetricAlert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *HostMetricAlert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *HostMetricAlert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *HostMetricAlert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *HostMetricAlert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *HostMetricAlert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMetricAlertConfigViewForNdsGroup.md b/docs/docs/HostMetricAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..faedf5b5 --- /dev/null +++ b/docs/docs/HostMetricAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# HostMetricAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**HostMetricEventTypeViewAlertable**](HostMetricEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]HostMatcher**](HostMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**MetricThreshold** | Pointer to [**HostMetricThreshold**](HostMetricThreshold.md) | | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewHostMetricAlertConfigViewForNdsGroup + +`func NewHostMetricAlertConfigViewForNdsGroup(eventTypeName HostMetricEventTypeViewAlertable, ) *HostMetricAlertConfigViewForNdsGroup` + +NewHostMetricAlertConfigViewForNdsGroup instantiates a new HostMetricAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostMetricAlertConfigViewForNdsGroupWithDefaults + +`func NewHostMetricAlertConfigViewForNdsGroupWithDefaults() *HostMetricAlertConfigViewForNdsGroup` + +NewHostMetricAlertConfigViewForNdsGroupWithDefaults instantiates a new HostMetricAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetEventTypeName() HostMetricEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*HostMetricEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetEventTypeName(v HostMetricEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetMatchers() []HostMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetMatchersOk() (*[]HostMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetMatchers(v []HostMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetMetricThreshold + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetMetricThreshold() HostMetricThreshold` + +GetMetricThreshold returns the MetricThreshold field if non-nil, zero value otherwise. + +### GetMetricThresholdOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetMetricThresholdOk() (*HostMetricThreshold, bool)` + +GetMetricThresholdOk returns a tuple with the MetricThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricThreshold + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetMetricThreshold(v HostMetricThreshold)` + +SetMetricThreshold sets MetricThreshold field to given value. + +### HasMetricThreshold + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasMetricThreshold() bool` + +HasMetricThreshold returns a boolean if a field has been set. + +### GetNotifications + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *HostMetricAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *HostMetricAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *HostMetricAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMetricEvent.md b/docs/docs/HostMetricEvent.md new file mode 100644 index 00000000..58cf5c99 --- /dev/null +++ b/docs/docs/HostMetricEvent.md @@ -0,0 +1,483 @@ +# HostMetricEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**NumberMetricValue**](NumberMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventType**](HostMetricEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewHostMetricEvent + +`func NewHostMetricEvent(created time.Time, eventTypeName HostMetricEventType, id string, ) *HostMetricEvent` + +NewHostMetricEvent instantiates a new HostMetricEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostMetricEventWithDefaults + +`func NewHostMetricEventWithDefaults() *HostMetricEvent` + +NewHostMetricEventWithDefaults instantiates a new HostMetricEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *HostMetricEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *HostMetricEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *HostMetricEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *HostMetricEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *HostMetricEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *HostMetricEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *HostMetricEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *HostMetricEvent) GetCurrentValue() NumberMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *HostMetricEvent) GetCurrentValueOk() (*NumberMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *HostMetricEvent) SetCurrentValue(v NumberMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *HostMetricEvent) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *HostMetricEvent) GetEventTypeName() HostMetricEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *HostMetricEvent) GetEventTypeNameOk() (*HostMetricEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *HostMetricEvent) SetEventTypeName(v HostMetricEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *HostMetricEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *HostMetricEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *HostMetricEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *HostMetricEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *HostMetricEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HostMetricEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HostMetricEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *HostMetricEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *HostMetricEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *HostMetricEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *HostMetricEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *HostMetricEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *HostMetricEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *HostMetricEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *HostMetricEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *HostMetricEvent) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *HostMetricEvent) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *HostMetricEvent) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *HostMetricEvent) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *HostMetricEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *HostMetricEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *HostMetricEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *HostMetricEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPort + +`func (o *HostMetricEvent) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *HostMetricEvent) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *HostMetricEvent) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *HostMetricEvent) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *HostMetricEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *HostMetricEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *HostMetricEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *HostMetricEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *HostMetricEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *HostMetricEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *HostMetricEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *HostMetricEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *HostMetricEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *HostMetricEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *HostMetricEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *HostMetricEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *HostMetricEvent) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *HostMetricEvent) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *HostMetricEvent) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *HostMetricEvent) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *HostMetricEvent) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *HostMetricEvent) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *HostMetricEvent) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *HostMetricEvent) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetUserId + +`func (o *HostMetricEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *HostMetricEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *HostMetricEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *HostMetricEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *HostMetricEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *HostMetricEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *HostMetricEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *HostMetricEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMetricEventType.md b/docs/docs/HostMetricEventType.md new file mode 100644 index 00000000..ef6559f0 --- /dev/null +++ b/docs/docs/HostMetricEventType.md @@ -0,0 +1,13 @@ +# HostMetricEventType + +## Enum + + +* `INSIDE_METRIC_THRESHOLD` (value: `"INSIDE_METRIC_THRESHOLD"`) + +* `OUTSIDE_METRIC_THRESHOLD` (value: `"OUTSIDE_METRIC_THRESHOLD"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMetricEventTypeViewAlertable.md b/docs/docs/HostMetricEventTypeViewAlertable.md new file mode 100644 index 00000000..b91e580c --- /dev/null +++ b/docs/docs/HostMetricEventTypeViewAlertable.md @@ -0,0 +1,11 @@ +# HostMetricEventTypeViewAlertable + +## Enum + + +* `OUTSIDE_METRIC_THRESHOLD` (value: `"OUTSIDE_METRIC_THRESHOLD"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMetricThreshold.md b/docs/docs/HostMetricThreshold.md new file mode 100644 index 00000000..7ade0c30 --- /dev/null +++ b/docs/docs/HostMetricThreshold.md @@ -0,0 +1,160 @@ +# HostMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**NumberMetricUnits**](NumberMetricUnits.md) | | [optional] + +## Methods + +### NewHostMetricThreshold + +`func NewHostMetricThreshold() *HostMetricThreshold` + +NewHostMetricThreshold instantiates a new HostMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostMetricThresholdWithDefaults + +`func NewHostMetricThresholdWithDefaults() *HostMetricThreshold` + +NewHostMetricThresholdWithDefaults instantiates a new HostMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *HostMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *HostMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *HostMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *HostMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *HostMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *HostMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *HostMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *HostMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *HostMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *HostMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *HostMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *HostMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *HostMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *HostMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *HostMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *HostMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *HostMetricThreshold) GetUnits() NumberMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *HostMetricThreshold) GetUnitsOk() (*NumberMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *HostMetricThreshold) SetUnits(v NumberMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *HostMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostMetricValue.md b/docs/docs/HostMetricValue.md new file mode 100644 index 00000000..d52f94d2 --- /dev/null +++ b/docs/docs/HostMetricValue.md @@ -0,0 +1,82 @@ +# HostMetricValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **float64** | Amount of the **metricName** recorded at the time of the event. This value triggered the alert. | [optional] [readonly] +**Units** | Pointer to **string** | | [optional] + +## Methods + +### NewHostMetricValue + +`func NewHostMetricValue() *HostMetricValue` + +NewHostMetricValue instantiates a new HostMetricValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostMetricValueWithDefaults + +`func NewHostMetricValueWithDefaults() *HostMetricValue` + +NewHostMetricValueWithDefaults instantiates a new HostMetricValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *HostMetricValue) GetNumber() float64` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *HostMetricValue) GetNumberOk() (*float64, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *HostMetricValue) SetNumber(v float64)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *HostMetricValue) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetUnits + +`func (o *HostMetricValue) GetUnits() string` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *HostMetricValue) GetUnitsOk() (*string, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *HostMetricValue) SetUnits(v string)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *HostMetricValue) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/HostViewAtlas.md b/docs/docs/HostViewAtlas.md new file mode 100644 index 00000000..b7753f05 --- /dev/null +++ b/docs/docs/HostViewAtlas.md @@ -0,0 +1,316 @@ +# HostViewAtlas + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. | [optional] [readonly] +**Hostname** | Pointer to **string** | Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). | [optional] [readonly] +**Id** | Pointer to **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**LastPing** | Pointer to **time.Time** | Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Links** | Pointer to [**[]LinkAtlas**](LinkAtlas.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Port** | Pointer to **int** | Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set. | [optional] [readonly] +**TypeName** | Pointer to **string** | Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process. | [optional] [readonly] +**UserAlias** | Pointer to **string** | Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter. | [optional] [readonly] +**Version** | Pointer to **string** | Version of MongoDB that this process runs. | [optional] [readonly] + +## Methods + +### NewHostViewAtlas + +`func NewHostViewAtlas() *HostViewAtlas` + +NewHostViewAtlas instantiates a new HostViewAtlas object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHostViewAtlasWithDefaults + +`func NewHostViewAtlasWithDefaults() *HostViewAtlas` + +NewHostViewAtlasWithDefaults instantiates a new HostViewAtlas object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *HostViewAtlas) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *HostViewAtlas) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *HostViewAtlas) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *HostViewAtlas) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetGroupId + +`func (o *HostViewAtlas) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *HostViewAtlas) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *HostViewAtlas) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *HostViewAtlas) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostname + +`func (o *HostViewAtlas) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *HostViewAtlas) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *HostViewAtlas) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *HostViewAtlas) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetId + +`func (o *HostViewAtlas) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HostViewAtlas) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HostViewAtlas) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *HostViewAtlas) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLastPing + +`func (o *HostViewAtlas) GetLastPing() time.Time` + +GetLastPing returns the LastPing field if non-nil, zero value otherwise. + +### GetLastPingOk + +`func (o *HostViewAtlas) GetLastPingOk() (*time.Time, bool)` + +GetLastPingOk returns a tuple with the LastPing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastPing + +`func (o *HostViewAtlas) SetLastPing(v time.Time)` + +SetLastPing sets LastPing field to given value. + +### HasLastPing + +`func (o *HostViewAtlas) HasLastPing() bool` + +HasLastPing returns a boolean if a field has been set. + +### GetLinks + +`func (o *HostViewAtlas) GetLinks() []LinkAtlas` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *HostViewAtlas) GetLinksOk() (*[]LinkAtlas, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *HostViewAtlas) SetLinks(v []LinkAtlas)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *HostViewAtlas) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetPort + +`func (o *HostViewAtlas) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *HostViewAtlas) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *HostViewAtlas) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *HostViewAtlas) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *HostViewAtlas) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *HostViewAtlas) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *HostViewAtlas) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *HostViewAtlas) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetTypeName + +`func (o *HostViewAtlas) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *HostViewAtlas) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *HostViewAtlas) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + +### HasTypeName + +`func (o *HostViewAtlas) HasTypeName() bool` + +HasTypeName returns a boolean if a field has been set. + +### GetUserAlias + +`func (o *HostViewAtlas) GetUserAlias() string` + +GetUserAlias returns the UserAlias field if non-nil, zero value otherwise. + +### GetUserAliasOk + +`func (o *HostViewAtlas) GetUserAliasOk() (*string, bool)` + +GetUserAliasOk returns a tuple with the UserAlias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserAlias + +`func (o *HostViewAtlas) SetUserAlias(v string)` + +SetUserAlias sets UserAlias field to given value. + +### HasUserAlias + +`func (o *HostViewAtlas) HasUserAlias() bool` + +HasUserAlias returns a boolean if a field has been set. + +### GetVersion + +`func (o *HostViewAtlas) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *HostViewAtlas) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *HostViewAtlas) SetVersion(v string)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *HostViewAtlas) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IdentityProvider.md b/docs/docs/IdentityProvider.md new file mode 100644 index 00000000..fce2f0bd --- /dev/null +++ b/docs/docs/IdentityProvider.md @@ -0,0 +1,363 @@ +# IdentityProvider + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcsUrl** | Pointer to **string** | URL that points to where to send the SAML response. | [optional] +**AssociatedDomains** | Pointer to **[]string** | List that contains the domains associated with the identity provider. | [optional] +**AssociatedOrgs** | Pointer to [**[]ConnectedOrgConfig**](ConnectedOrgConfig.md) | List that contains the connected organization configurations associated with the identity provider. | [optional] +**AudienceUri** | Pointer to **string** | Unique string that identifies the intended audience of the SAML assertion. | [optional] +**DisplayName** | Pointer to **string** | Human-readable label that identifies the identity provider. | [optional] +**IssuerUri** | Pointer to **string** | Unique string that identifies the issuer of the SAML Assertion. | [optional] +**OktaIdpId** | **string** | Unique 20-hexadecimal digit string that identifies the identity provider. | +**PemFileInfo** | Pointer to [**PemFileInfo**](PemFileInfo.md) | | [optional] +**RequestBinding** | Pointer to **string** | SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. | [optional] +**ResponseSignatureAlgorithm** | Pointer to **string** | Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. | [optional] +**SsoDebugEnabled** | Pointer to **bool** | Flag that indicates whether the identity provider has SSO debug enabled. | [optional] +**SsoUrl** | Pointer to **string** | URL that points to the receiver of the SAML authentication request. | [optional] +**Status** | Pointer to **string** | String enum that indicates whether the identity provider is active. | [optional] + +## Methods + +### NewIdentityProvider + +`func NewIdentityProvider(oktaIdpId string, ) *IdentityProvider` + +NewIdentityProvider instantiates a new IdentityProvider object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIdentityProviderWithDefaults + +`func NewIdentityProviderWithDefaults() *IdentityProvider` + +NewIdentityProviderWithDefaults instantiates a new IdentityProvider object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcsUrl + +`func (o *IdentityProvider) GetAcsUrl() string` + +GetAcsUrl returns the AcsUrl field if non-nil, zero value otherwise. + +### GetAcsUrlOk + +`func (o *IdentityProvider) GetAcsUrlOk() (*string, bool)` + +GetAcsUrlOk returns a tuple with the AcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcsUrl + +`func (o *IdentityProvider) SetAcsUrl(v string)` + +SetAcsUrl sets AcsUrl field to given value. + +### HasAcsUrl + +`func (o *IdentityProvider) HasAcsUrl() bool` + +HasAcsUrl returns a boolean if a field has been set. + +### GetAssociatedDomains + +`func (o *IdentityProvider) GetAssociatedDomains() []string` + +GetAssociatedDomains returns the AssociatedDomains field if non-nil, zero value otherwise. + +### GetAssociatedDomainsOk + +`func (o *IdentityProvider) GetAssociatedDomainsOk() (*[]string, bool)` + +GetAssociatedDomainsOk returns a tuple with the AssociatedDomains field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedDomains + +`func (o *IdentityProvider) SetAssociatedDomains(v []string)` + +SetAssociatedDomains sets AssociatedDomains field to given value. + +### HasAssociatedDomains + +`func (o *IdentityProvider) HasAssociatedDomains() bool` + +HasAssociatedDomains returns a boolean if a field has been set. + +### GetAssociatedOrgs + +`func (o *IdentityProvider) GetAssociatedOrgs() []ConnectedOrgConfig` + +GetAssociatedOrgs returns the AssociatedOrgs field if non-nil, zero value otherwise. + +### GetAssociatedOrgsOk + +`func (o *IdentityProvider) GetAssociatedOrgsOk() (*[]ConnectedOrgConfig, bool)` + +GetAssociatedOrgsOk returns a tuple with the AssociatedOrgs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedOrgs + +`func (o *IdentityProvider) SetAssociatedOrgs(v []ConnectedOrgConfig)` + +SetAssociatedOrgs sets AssociatedOrgs field to given value. + +### HasAssociatedOrgs + +`func (o *IdentityProvider) HasAssociatedOrgs() bool` + +HasAssociatedOrgs returns a boolean if a field has been set. + +### GetAudienceUri + +`func (o *IdentityProvider) GetAudienceUri() string` + +GetAudienceUri returns the AudienceUri field if non-nil, zero value otherwise. + +### GetAudienceUriOk + +`func (o *IdentityProvider) GetAudienceUriOk() (*string, bool)` + +GetAudienceUriOk returns a tuple with the AudienceUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAudienceUri + +`func (o *IdentityProvider) SetAudienceUri(v string)` + +SetAudienceUri sets AudienceUri field to given value. + +### HasAudienceUri + +`func (o *IdentityProvider) HasAudienceUri() bool` + +HasAudienceUri returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityProvider) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityProvider) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityProvider) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityProvider) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetIssuerUri + +`func (o *IdentityProvider) GetIssuerUri() string` + +GetIssuerUri returns the IssuerUri field if non-nil, zero value otherwise. + +### GetIssuerUriOk + +`func (o *IdentityProvider) GetIssuerUriOk() (*string, bool)` + +GetIssuerUriOk returns a tuple with the IssuerUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuerUri + +`func (o *IdentityProvider) SetIssuerUri(v string)` + +SetIssuerUri sets IssuerUri field to given value. + +### HasIssuerUri + +`func (o *IdentityProvider) HasIssuerUri() bool` + +HasIssuerUri returns a boolean if a field has been set. + +### GetOktaIdpId + +`func (o *IdentityProvider) GetOktaIdpId() string` + +GetOktaIdpId returns the OktaIdpId field if non-nil, zero value otherwise. + +### GetOktaIdpIdOk + +`func (o *IdentityProvider) GetOktaIdpIdOk() (*string, bool)` + +GetOktaIdpIdOk returns a tuple with the OktaIdpId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOktaIdpId + +`func (o *IdentityProvider) SetOktaIdpId(v string)` + +SetOktaIdpId sets OktaIdpId field to given value. + + +### GetPemFileInfo + +`func (o *IdentityProvider) GetPemFileInfo() PemFileInfo` + +GetPemFileInfo returns the PemFileInfo field if non-nil, zero value otherwise. + +### GetPemFileInfoOk + +`func (o *IdentityProvider) GetPemFileInfoOk() (*PemFileInfo, bool)` + +GetPemFileInfoOk returns a tuple with the PemFileInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPemFileInfo + +`func (o *IdentityProvider) SetPemFileInfo(v PemFileInfo)` + +SetPemFileInfo sets PemFileInfo field to given value. + +### HasPemFileInfo + +`func (o *IdentityProvider) HasPemFileInfo() bool` + +HasPemFileInfo returns a boolean if a field has been set. + +### GetRequestBinding + +`func (o *IdentityProvider) GetRequestBinding() string` + +GetRequestBinding returns the RequestBinding field if non-nil, zero value otherwise. + +### GetRequestBindingOk + +`func (o *IdentityProvider) GetRequestBindingOk() (*string, bool)` + +GetRequestBindingOk returns a tuple with the RequestBinding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestBinding + +`func (o *IdentityProvider) SetRequestBinding(v string)` + +SetRequestBinding sets RequestBinding field to given value. + +### HasRequestBinding + +`func (o *IdentityProvider) HasRequestBinding() bool` + +HasRequestBinding returns a boolean if a field has been set. + +### GetResponseSignatureAlgorithm + +`func (o *IdentityProvider) GetResponseSignatureAlgorithm() string` + +GetResponseSignatureAlgorithm returns the ResponseSignatureAlgorithm field if non-nil, zero value otherwise. + +### GetResponseSignatureAlgorithmOk + +`func (o *IdentityProvider) GetResponseSignatureAlgorithmOk() (*string, bool)` + +GetResponseSignatureAlgorithmOk returns a tuple with the ResponseSignatureAlgorithm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseSignatureAlgorithm + +`func (o *IdentityProvider) SetResponseSignatureAlgorithm(v string)` + +SetResponseSignatureAlgorithm sets ResponseSignatureAlgorithm field to given value. + +### HasResponseSignatureAlgorithm + +`func (o *IdentityProvider) HasResponseSignatureAlgorithm() bool` + +HasResponseSignatureAlgorithm returns a boolean if a field has been set. + +### GetSsoDebugEnabled + +`func (o *IdentityProvider) GetSsoDebugEnabled() bool` + +GetSsoDebugEnabled returns the SsoDebugEnabled field if non-nil, zero value otherwise. + +### GetSsoDebugEnabledOk + +`func (o *IdentityProvider) GetSsoDebugEnabledOk() (*bool, bool)` + +GetSsoDebugEnabledOk returns a tuple with the SsoDebugEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSsoDebugEnabled + +`func (o *IdentityProvider) SetSsoDebugEnabled(v bool)` + +SetSsoDebugEnabled sets SsoDebugEnabled field to given value. + +### HasSsoDebugEnabled + +`func (o *IdentityProvider) HasSsoDebugEnabled() bool` + +HasSsoDebugEnabled returns a boolean if a field has been set. + +### GetSsoUrl + +`func (o *IdentityProvider) GetSsoUrl() string` + +GetSsoUrl returns the SsoUrl field if non-nil, zero value otherwise. + +### GetSsoUrlOk + +`func (o *IdentityProvider) GetSsoUrlOk() (*string, bool)` + +GetSsoUrlOk returns a tuple with the SsoUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSsoUrl + +`func (o *IdentityProvider) SetSsoUrl(v string)` + +SetSsoUrl sets SsoUrl field to given value. + +### HasSsoUrl + +`func (o *IdentityProvider) HasSsoUrl() bool` + +HasSsoUrl returns a boolean if a field has been set. + +### GetStatus + +`func (o *IdentityProvider) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentityProvider) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentityProvider) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *IdentityProvider) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IdentityProviderUpdate.md b/docs/docs/IdentityProviderUpdate.md new file mode 100644 index 00000000..9aec1cbb --- /dev/null +++ b/docs/docs/IdentityProviderUpdate.md @@ -0,0 +1,259 @@ +# IdentityProviderUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociatedDomains** | Pointer to **[]string** | List that contains the domains associated with the identity provider. | [optional] +**DisplayName** | Pointer to **string** | Human-readable label that identifies the identity provider. | [optional] +**IssuerUri** | Pointer to **string** | Unique string that identifies the issuer of the SAML Assertion. | [optional] +**PemFileInfo** | Pointer to [**PemFileInfo**](PemFileInfo.md) | | [optional] +**RequestBinding** | Pointer to **string** | SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. | [optional] +**ResponseSignatureAlgorithm** | Pointer to **string** | Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. | [optional] +**SsoDebugEnabled** | **bool** | Flag that indicates whether the identity provider has SSO debug enabled. | +**SsoUrl** | Pointer to **string** | Unique string that identifies the intended audience of the SAML assertion. | [optional] +**Status** | Pointer to **string** | String enum that indicates whether the identity provider is active. | [optional] + +## Methods + +### NewIdentityProviderUpdate + +`func NewIdentityProviderUpdate(ssoDebugEnabled bool, ) *IdentityProviderUpdate` + +NewIdentityProviderUpdate instantiates a new IdentityProviderUpdate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIdentityProviderUpdateWithDefaults + +`func NewIdentityProviderUpdateWithDefaults() *IdentityProviderUpdate` + +NewIdentityProviderUpdateWithDefaults instantiates a new IdentityProviderUpdate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAssociatedDomains + +`func (o *IdentityProviderUpdate) GetAssociatedDomains() []string` + +GetAssociatedDomains returns the AssociatedDomains field if non-nil, zero value otherwise. + +### GetAssociatedDomainsOk + +`func (o *IdentityProviderUpdate) GetAssociatedDomainsOk() (*[]string, bool)` + +GetAssociatedDomainsOk returns a tuple with the AssociatedDomains field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedDomains + +`func (o *IdentityProviderUpdate) SetAssociatedDomains(v []string)` + +SetAssociatedDomains sets AssociatedDomains field to given value. + +### HasAssociatedDomains + +`func (o *IdentityProviderUpdate) HasAssociatedDomains() bool` + +HasAssociatedDomains returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityProviderUpdate) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityProviderUpdate) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityProviderUpdate) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityProviderUpdate) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetIssuerUri + +`func (o *IdentityProviderUpdate) GetIssuerUri() string` + +GetIssuerUri returns the IssuerUri field if non-nil, zero value otherwise. + +### GetIssuerUriOk + +`func (o *IdentityProviderUpdate) GetIssuerUriOk() (*string, bool)` + +GetIssuerUriOk returns a tuple with the IssuerUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIssuerUri + +`func (o *IdentityProviderUpdate) SetIssuerUri(v string)` + +SetIssuerUri sets IssuerUri field to given value. + +### HasIssuerUri + +`func (o *IdentityProviderUpdate) HasIssuerUri() bool` + +HasIssuerUri returns a boolean if a field has been set. + +### GetPemFileInfo + +`func (o *IdentityProviderUpdate) GetPemFileInfo() PemFileInfo` + +GetPemFileInfo returns the PemFileInfo field if non-nil, zero value otherwise. + +### GetPemFileInfoOk + +`func (o *IdentityProviderUpdate) GetPemFileInfoOk() (*PemFileInfo, bool)` + +GetPemFileInfoOk returns a tuple with the PemFileInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPemFileInfo + +`func (o *IdentityProviderUpdate) SetPemFileInfo(v PemFileInfo)` + +SetPemFileInfo sets PemFileInfo field to given value. + +### HasPemFileInfo + +`func (o *IdentityProviderUpdate) HasPemFileInfo() bool` + +HasPemFileInfo returns a boolean if a field has been set. + +### GetRequestBinding + +`func (o *IdentityProviderUpdate) GetRequestBinding() string` + +GetRequestBinding returns the RequestBinding field if non-nil, zero value otherwise. + +### GetRequestBindingOk + +`func (o *IdentityProviderUpdate) GetRequestBindingOk() (*string, bool)` + +GetRequestBindingOk returns a tuple with the RequestBinding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestBinding + +`func (o *IdentityProviderUpdate) SetRequestBinding(v string)` + +SetRequestBinding sets RequestBinding field to given value. + +### HasRequestBinding + +`func (o *IdentityProviderUpdate) HasRequestBinding() bool` + +HasRequestBinding returns a boolean if a field has been set. + +### GetResponseSignatureAlgorithm + +`func (o *IdentityProviderUpdate) GetResponseSignatureAlgorithm() string` + +GetResponseSignatureAlgorithm returns the ResponseSignatureAlgorithm field if non-nil, zero value otherwise. + +### GetResponseSignatureAlgorithmOk + +`func (o *IdentityProviderUpdate) GetResponseSignatureAlgorithmOk() (*string, bool)` + +GetResponseSignatureAlgorithmOk returns a tuple with the ResponseSignatureAlgorithm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseSignatureAlgorithm + +`func (o *IdentityProviderUpdate) SetResponseSignatureAlgorithm(v string)` + +SetResponseSignatureAlgorithm sets ResponseSignatureAlgorithm field to given value. + +### HasResponseSignatureAlgorithm + +`func (o *IdentityProviderUpdate) HasResponseSignatureAlgorithm() bool` + +HasResponseSignatureAlgorithm returns a boolean if a field has been set. + +### GetSsoDebugEnabled + +`func (o *IdentityProviderUpdate) GetSsoDebugEnabled() bool` + +GetSsoDebugEnabled returns the SsoDebugEnabled field if non-nil, zero value otherwise. + +### GetSsoDebugEnabledOk + +`func (o *IdentityProviderUpdate) GetSsoDebugEnabledOk() (*bool, bool)` + +GetSsoDebugEnabledOk returns a tuple with the SsoDebugEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSsoDebugEnabled + +`func (o *IdentityProviderUpdate) SetSsoDebugEnabled(v bool)` + +SetSsoDebugEnabled sets SsoDebugEnabled field to given value. + + +### GetSsoUrl + +`func (o *IdentityProviderUpdate) GetSsoUrl() string` + +GetSsoUrl returns the SsoUrl field if non-nil, zero value otherwise. + +### GetSsoUrlOk + +`func (o *IdentityProviderUpdate) GetSsoUrlOk() (*string, bool)` + +GetSsoUrlOk returns a tuple with the SsoUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSsoUrl + +`func (o *IdentityProviderUpdate) SetSsoUrl(v string)` + +SetSsoUrl sets SsoUrl field to given value. + +### HasSsoUrl + +`func (o *IdentityProviderUpdate) HasSsoUrl() bool` + +HasSsoUrl returns a boolean if a field has been set. + +### GetStatus + +`func (o *IdentityProviderUpdate) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentityProviderUpdate) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentityProviderUpdate) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *IdentityProviderUpdate) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IndexOptions.md b/docs/docs/IndexOptions.md new file mode 100644 index 00000000..b4b87660 --- /dev/null +++ b/docs/docs/IndexOptions.md @@ -0,0 +1,493 @@ +# IndexOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Var2dsphereIndexVersion** | **int** | Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only. | [default to 3] +**Background** | Pointer to **bool** | Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types. | [optional] [default to false] +**Bits** | Pointer to **int** | Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only. | [optional] [default to 26] +**BucketSize** | Pointer to **int** | Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only. MongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command. | [optional] +**ColumnstoreProjection** | Pointer to **map[string]int** | The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the <value> can be either of the following: 1 or true to include the field and recursively all fields it is a prefix of in the index 0 or false to exclude the field and recursively all fields it is a prefix of from the index. | [optional] +**DefaultLanguage** | Pointer to **string** | Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only. | [optional] [default to "english"] +**ExpireAfterSeconds** | Pointer to **int** | Number of seconds that MongoDB retains documents in a Time To Live (TTL) index. | [optional] +**Hidden** | Pointer to **bool** | Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection. | [optional] [default to false] +**LanguageOverride** | Pointer to **string** | Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only. | [optional] [default to "language"] +**Max** | Pointer to **int** | Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only. | [optional] [default to 180] +**Min** | Pointer to **int** | Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only. | [optional] [default to -180] +**Name** | Pointer to **string** | Human-readable label that identifies this index. This option applies to all index types. | [optional] +**PartialFilterExpression** | Pointer to **map[string]map[string]interface{}** | Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions: - equality (`\"parameter\" : \"value\"` or using the `$eq` operator) - `\"$exists\": true` , maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons - `$type` - `$and` (top-level only) This option applies to all index types. | [optional] +**Sparse** | Pointer to **bool** | Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`. Compound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types. | [optional] [default to false] +**StorageEngine** | Pointer to **map[string]map[string]interface{}** | Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"<storage-engine-name>\" : \"<options>\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types. | [optional] +**TextIndexVersion** | Pointer to **int** | Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only. | [optional] [default to 3] +**Unique** | Pointer to **bool** | Flag that indicates whether this index can accept insertion or update of documents when the index key value matches an existing index key value. Set `\"unique\" : true` to set this index as unique. You can't set a hashed index to be unique. This option applies to all index types. | [optional] [default to false] +**Weights** | Pointer to **map[string]map[string]interface{}** | Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only. | [optional] + +## Methods + +### NewIndexOptions + +`func NewIndexOptions(var2dsphereIndexVersion int, ) *IndexOptions` + +NewIndexOptions instantiates a new IndexOptions object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIndexOptionsWithDefaults + +`func NewIndexOptionsWithDefaults() *IndexOptions` + +NewIndexOptionsWithDefaults instantiates a new IndexOptions object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetVar2dsphereIndexVersion + +`func (o *IndexOptions) GetVar2dsphereIndexVersion() int` + +GetVar2dsphereIndexVersion returns the Var2dsphereIndexVersion field if non-nil, zero value otherwise. + +### GetVar2dsphereIndexVersionOk + +`func (o *IndexOptions) GetVar2dsphereIndexVersionOk() (*int, bool)` + +GetVar2dsphereIndexVersionOk returns a tuple with the Var2dsphereIndexVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVar2dsphereIndexVersion + +`func (o *IndexOptions) SetVar2dsphereIndexVersion(v int)` + +SetVar2dsphereIndexVersion sets Var2dsphereIndexVersion field to given value. + + +### GetBackground + +`func (o *IndexOptions) GetBackground() bool` + +GetBackground returns the Background field if non-nil, zero value otherwise. + +### GetBackgroundOk + +`func (o *IndexOptions) GetBackgroundOk() (*bool, bool)` + +GetBackgroundOk returns a tuple with the Background field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackground + +`func (o *IndexOptions) SetBackground(v bool)` + +SetBackground sets Background field to given value. + +### HasBackground + +`func (o *IndexOptions) HasBackground() bool` + +HasBackground returns a boolean if a field has been set. + +### GetBits + +`func (o *IndexOptions) GetBits() int` + +GetBits returns the Bits field if non-nil, zero value otherwise. + +### GetBitsOk + +`func (o *IndexOptions) GetBitsOk() (*int, bool)` + +GetBitsOk returns a tuple with the Bits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBits + +`func (o *IndexOptions) SetBits(v int)` + +SetBits sets Bits field to given value. + +### HasBits + +`func (o *IndexOptions) HasBits() bool` + +HasBits returns a boolean if a field has been set. + +### GetBucketSize + +`func (o *IndexOptions) GetBucketSize() int` + +GetBucketSize returns the BucketSize field if non-nil, zero value otherwise. + +### GetBucketSizeOk + +`func (o *IndexOptions) GetBucketSizeOk() (*int, bool)` + +GetBucketSizeOk returns a tuple with the BucketSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucketSize + +`func (o *IndexOptions) SetBucketSize(v int)` + +SetBucketSize sets BucketSize field to given value. + +### HasBucketSize + +`func (o *IndexOptions) HasBucketSize() bool` + +HasBucketSize returns a boolean if a field has been set. + +### GetColumnstoreProjection + +`func (o *IndexOptions) GetColumnstoreProjection() map[string]int` + +GetColumnstoreProjection returns the ColumnstoreProjection field if non-nil, zero value otherwise. + +### GetColumnstoreProjectionOk + +`func (o *IndexOptions) GetColumnstoreProjectionOk() (*map[string]int, bool)` + +GetColumnstoreProjectionOk returns a tuple with the ColumnstoreProjection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumnstoreProjection + +`func (o *IndexOptions) SetColumnstoreProjection(v map[string]int)` + +SetColumnstoreProjection sets ColumnstoreProjection field to given value. + +### HasColumnstoreProjection + +`func (o *IndexOptions) HasColumnstoreProjection() bool` + +HasColumnstoreProjection returns a boolean if a field has been set. + +### GetDefaultLanguage + +`func (o *IndexOptions) GetDefaultLanguage() string` + +GetDefaultLanguage returns the DefaultLanguage field if non-nil, zero value otherwise. + +### GetDefaultLanguageOk + +`func (o *IndexOptions) GetDefaultLanguageOk() (*string, bool)` + +GetDefaultLanguageOk returns a tuple with the DefaultLanguage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultLanguage + +`func (o *IndexOptions) SetDefaultLanguage(v string)` + +SetDefaultLanguage sets DefaultLanguage field to given value. + +### HasDefaultLanguage + +`func (o *IndexOptions) HasDefaultLanguage() bool` + +HasDefaultLanguage returns a boolean if a field has been set. + +### GetExpireAfterSeconds + +`func (o *IndexOptions) GetExpireAfterSeconds() int` + +GetExpireAfterSeconds returns the ExpireAfterSeconds field if non-nil, zero value otherwise. + +### GetExpireAfterSecondsOk + +`func (o *IndexOptions) GetExpireAfterSecondsOk() (*int, bool)` + +GetExpireAfterSecondsOk returns a tuple with the ExpireAfterSeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpireAfterSeconds + +`func (o *IndexOptions) SetExpireAfterSeconds(v int)` + +SetExpireAfterSeconds sets ExpireAfterSeconds field to given value. + +### HasExpireAfterSeconds + +`func (o *IndexOptions) HasExpireAfterSeconds() bool` + +HasExpireAfterSeconds returns a boolean if a field has been set. + +### GetHidden + +`func (o *IndexOptions) GetHidden() bool` + +GetHidden returns the Hidden field if non-nil, zero value otherwise. + +### GetHiddenOk + +`func (o *IndexOptions) GetHiddenOk() (*bool, bool)` + +GetHiddenOk returns a tuple with the Hidden field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHidden + +`func (o *IndexOptions) SetHidden(v bool)` + +SetHidden sets Hidden field to given value. + +### HasHidden + +`func (o *IndexOptions) HasHidden() bool` + +HasHidden returns a boolean if a field has been set. + +### GetLanguageOverride + +`func (o *IndexOptions) GetLanguageOverride() string` + +GetLanguageOverride returns the LanguageOverride field if non-nil, zero value otherwise. + +### GetLanguageOverrideOk + +`func (o *IndexOptions) GetLanguageOverrideOk() (*string, bool)` + +GetLanguageOverrideOk returns a tuple with the LanguageOverride field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLanguageOverride + +`func (o *IndexOptions) SetLanguageOverride(v string)` + +SetLanguageOverride sets LanguageOverride field to given value. + +### HasLanguageOverride + +`func (o *IndexOptions) HasLanguageOverride() bool` + +HasLanguageOverride returns a boolean if a field has been set. + +### GetMax + +`func (o *IndexOptions) GetMax() int` + +GetMax returns the Max field if non-nil, zero value otherwise. + +### GetMaxOk + +`func (o *IndexOptions) GetMaxOk() (*int, bool)` + +GetMaxOk returns a tuple with the Max field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMax + +`func (o *IndexOptions) SetMax(v int)` + +SetMax sets Max field to given value. + +### HasMax + +`func (o *IndexOptions) HasMax() bool` + +HasMax returns a boolean if a field has been set. + +### GetMin + +`func (o *IndexOptions) GetMin() int` + +GetMin returns the Min field if non-nil, zero value otherwise. + +### GetMinOk + +`func (o *IndexOptions) GetMinOk() (*int, bool)` + +GetMinOk returns a tuple with the Min field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMin + +`func (o *IndexOptions) SetMin(v int)` + +SetMin sets Min field to given value. + +### HasMin + +`func (o *IndexOptions) HasMin() bool` + +HasMin returns a boolean if a field has been set. + +### GetName + +`func (o *IndexOptions) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IndexOptions) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IndexOptions) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IndexOptions) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPartialFilterExpression + +`func (o *IndexOptions) GetPartialFilterExpression() map[string]map[string]interface{}` + +GetPartialFilterExpression returns the PartialFilterExpression field if non-nil, zero value otherwise. + +### GetPartialFilterExpressionOk + +`func (o *IndexOptions) GetPartialFilterExpressionOk() (*map[string]map[string]interface{}, bool)` + +GetPartialFilterExpressionOk returns a tuple with the PartialFilterExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartialFilterExpression + +`func (o *IndexOptions) SetPartialFilterExpression(v map[string]map[string]interface{})` + +SetPartialFilterExpression sets PartialFilterExpression field to given value. + +### HasPartialFilterExpression + +`func (o *IndexOptions) HasPartialFilterExpression() bool` + +HasPartialFilterExpression returns a boolean if a field has been set. + +### GetSparse + +`func (o *IndexOptions) GetSparse() bool` + +GetSparse returns the Sparse field if non-nil, zero value otherwise. + +### GetSparseOk + +`func (o *IndexOptions) GetSparseOk() (*bool, bool)` + +GetSparseOk returns a tuple with the Sparse field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSparse + +`func (o *IndexOptions) SetSparse(v bool)` + +SetSparse sets Sparse field to given value. + +### HasSparse + +`func (o *IndexOptions) HasSparse() bool` + +HasSparse returns a boolean if a field has been set. + +### GetStorageEngine + +`func (o *IndexOptions) GetStorageEngine() map[string]map[string]interface{}` + +GetStorageEngine returns the StorageEngine field if non-nil, zero value otherwise. + +### GetStorageEngineOk + +`func (o *IndexOptions) GetStorageEngineOk() (*map[string]map[string]interface{}, bool)` + +GetStorageEngineOk returns a tuple with the StorageEngine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageEngine + +`func (o *IndexOptions) SetStorageEngine(v map[string]map[string]interface{})` + +SetStorageEngine sets StorageEngine field to given value. + +### HasStorageEngine + +`func (o *IndexOptions) HasStorageEngine() bool` + +HasStorageEngine returns a boolean if a field has been set. + +### GetTextIndexVersion + +`func (o *IndexOptions) GetTextIndexVersion() int` + +GetTextIndexVersion returns the TextIndexVersion field if non-nil, zero value otherwise. + +### GetTextIndexVersionOk + +`func (o *IndexOptions) GetTextIndexVersionOk() (*int, bool)` + +GetTextIndexVersionOk returns a tuple with the TextIndexVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTextIndexVersion + +`func (o *IndexOptions) SetTextIndexVersion(v int)` + +SetTextIndexVersion sets TextIndexVersion field to given value. + +### HasTextIndexVersion + +`func (o *IndexOptions) HasTextIndexVersion() bool` + +HasTextIndexVersion returns a boolean if a field has been set. + +### GetUnique + +`func (o *IndexOptions) GetUnique() bool` + +GetUnique returns the Unique field if non-nil, zero value otherwise. + +### GetUniqueOk + +`func (o *IndexOptions) GetUniqueOk() (*bool, bool)` + +GetUniqueOk returns a tuple with the Unique field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnique + +`func (o *IndexOptions) SetUnique(v bool)` + +SetUnique sets Unique field to given value. + +### HasUnique + +`func (o *IndexOptions) HasUnique() bool` + +HasUnique returns a boolean if a field has been set. + +### GetWeights + +`func (o *IndexOptions) GetWeights() map[string]map[string]interface{}` + +GetWeights returns the Weights field if non-nil, zero value otherwise. + +### GetWeightsOk + +`func (o *IndexOptions) GetWeightsOk() (*map[string]map[string]interface{}, bool)` + +GetWeightsOk returns a tuple with the Weights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWeights + +`func (o *IndexOptions) SetWeights(v map[string]map[string]interface{})` + +SetWeights sets Weights field to given value. + +### HasWeights + +`func (o *IndexOptions) HasWeights() bool` + +HasWeights returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IndexRequest.md b/docs/docs/IndexRequest.md new file mode 100644 index 00000000..e5a01e39 --- /dev/null +++ b/docs/docs/IndexRequest.md @@ -0,0 +1,150 @@ +# IndexRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Collation** | Pointer to [**Collation**](Collation.md) | | [optional] +**Collection** | **string** | Human-readable label of the collection for which MongoDB Cloud creates an index. | +**Db** | **string** | Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index. | +**Keys** | Pointer to **[]map[string]string** | List that contains one or more objects that describe the parameters that you want to index. | [optional] +**Options** | Pointer to [**IndexOptions**](IndexOptions.md) | | [optional] + +## Methods + +### NewIndexRequest + +`func NewIndexRequest(collection string, db string, ) *IndexRequest` + +NewIndexRequest instantiates a new IndexRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIndexRequestWithDefaults + +`func NewIndexRequestWithDefaults() *IndexRequest` + +NewIndexRequestWithDefaults instantiates a new IndexRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCollation + +`func (o *IndexRequest) GetCollation() Collation` + +GetCollation returns the Collation field if non-nil, zero value otherwise. + +### GetCollationOk + +`func (o *IndexRequest) GetCollationOk() (*Collation, bool)` + +GetCollationOk returns a tuple with the Collation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollation + +`func (o *IndexRequest) SetCollation(v Collation)` + +SetCollation sets Collation field to given value. + +### HasCollation + +`func (o *IndexRequest) HasCollation() bool` + +HasCollation returns a boolean if a field has been set. + +### GetCollection + +`func (o *IndexRequest) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *IndexRequest) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *IndexRequest) SetCollection(v string)` + +SetCollection sets Collection field to given value. + + +### GetDb + +`func (o *IndexRequest) GetDb() string` + +GetDb returns the Db field if non-nil, zero value otherwise. + +### GetDbOk + +`func (o *IndexRequest) GetDbOk() (*string, bool)` + +GetDbOk returns a tuple with the Db field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDb + +`func (o *IndexRequest) SetDb(v string)` + +SetDb sets Db field to given value. + + +### GetKeys + +`func (o *IndexRequest) GetKeys() []map[string]string` + +GetKeys returns the Keys field if non-nil, zero value otherwise. + +### GetKeysOk + +`func (o *IndexRequest) GetKeysOk() (*[]map[string]string, bool)` + +GetKeysOk returns a tuple with the Keys field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeys + +`func (o *IndexRequest) SetKeys(v []map[string]string)` + +SetKeys sets Keys field to given value. + +### HasKeys + +`func (o *IndexRequest) HasKeys() bool` + +HasKeys returns a boolean if a field has been set. + +### GetOptions + +`func (o *IndexRequest) GetOptions() IndexOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *IndexRequest) GetOptionsOk() (*IndexOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *IndexRequest) SetOptions(v IndexOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *IndexRequest) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IngestionPipeline.md b/docs/docs/IngestionPipeline.md new file mode 100644 index 00000000..de9fe142 --- /dev/null +++ b/docs/docs/IngestionPipeline.md @@ -0,0 +1,264 @@ +# IngestionPipeline + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline. | [optional] [readonly] +**CreatedDate** | Pointer to **time.Time** | Timestamp that indicates when the Data Lake Pipeline was created. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the group. | [optional] [readonly] +**LastUpdatedDate** | Pointer to **time.Time** | Timestamp that indicates the last time that the Data Lake Pipeline was updated. | [optional] [readonly] +**Name** | Pointer to **string** | Name of this Data Lake Pipeline. | [optional] +**Sink** | Pointer to [**IngestionSink**](IngestionSink.md) | | [optional] +**Source** | Pointer to [**IngestionSource**](IngestionSource.md) | | [optional] +**State** | Pointer to **string** | State of this Data Lake Pipeline. | [optional] [readonly] +**Transformations** | Pointer to [**[]FieldTransformation**](FieldTransformation.md) | Fields to be excluded for this Data Lake Pipeline. | [optional] + +## Methods + +### NewIngestionPipeline + +`func NewIngestionPipeline() *IngestionPipeline` + +NewIngestionPipeline instantiates a new IngestionPipeline object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIngestionPipelineWithDefaults + +`func NewIngestionPipelineWithDefaults() *IngestionPipeline` + +NewIngestionPipelineWithDefaults instantiates a new IngestionPipeline object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *IngestionPipeline) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IngestionPipeline) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IngestionPipeline) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IngestionPipeline) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *IngestionPipeline) GetCreatedDate() time.Time` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *IngestionPipeline) GetCreatedDateOk() (*time.Time, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *IngestionPipeline) SetCreatedDate(v time.Time)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *IngestionPipeline) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetGroupId + +`func (o *IngestionPipeline) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *IngestionPipeline) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *IngestionPipeline) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *IngestionPipeline) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetLastUpdatedDate + +`func (o *IngestionPipeline) GetLastUpdatedDate() time.Time` + +GetLastUpdatedDate returns the LastUpdatedDate field if non-nil, zero value otherwise. + +### GetLastUpdatedDateOk + +`func (o *IngestionPipeline) GetLastUpdatedDateOk() (*time.Time, bool)` + +GetLastUpdatedDateOk returns a tuple with the LastUpdatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdatedDate + +`func (o *IngestionPipeline) SetLastUpdatedDate(v time.Time)` + +SetLastUpdatedDate sets LastUpdatedDate field to given value. + +### HasLastUpdatedDate + +`func (o *IngestionPipeline) HasLastUpdatedDate() bool` + +HasLastUpdatedDate returns a boolean if a field has been set. + +### GetName + +`func (o *IngestionPipeline) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IngestionPipeline) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IngestionPipeline) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IngestionPipeline) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSink + +`func (o *IngestionPipeline) GetSink() IngestionSink` + +GetSink returns the Sink field if non-nil, zero value otherwise. + +### GetSinkOk + +`func (o *IngestionPipeline) GetSinkOk() (*IngestionSink, bool)` + +GetSinkOk returns a tuple with the Sink field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSink + +`func (o *IngestionPipeline) SetSink(v IngestionSink)` + +SetSink sets Sink field to given value. + +### HasSink + +`func (o *IngestionPipeline) HasSink() bool` + +HasSink returns a boolean if a field has been set. + +### GetSource + +`func (o *IngestionPipeline) GetSource() IngestionSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *IngestionPipeline) GetSourceOk() (*IngestionSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *IngestionPipeline) SetSource(v IngestionSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *IngestionPipeline) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetState + +`func (o *IngestionPipeline) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *IngestionPipeline) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *IngestionPipeline) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *IngestionPipeline) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTransformations + +`func (o *IngestionPipeline) GetTransformations() []FieldTransformation` + +GetTransformations returns the Transformations field if non-nil, zero value otherwise. + +### GetTransformationsOk + +`func (o *IngestionPipeline) GetTransformationsOk() (*[]FieldTransformation, bool)` + +GetTransformationsOk returns a tuple with the Transformations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransformations + +`func (o *IngestionPipeline) SetTransformations(v []FieldTransformation)` + +SetTransformations sets Transformations field to given value. + +### HasTransformations + +`func (o *IngestionPipeline) HasTransformations() bool` + +HasTransformations returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IngestionPipelineRun.md b/docs/docs/IngestionPipelineRun.md new file mode 100644 index 00000000..1642ecb9 --- /dev/null +++ b/docs/docs/IngestionPipelineRun.md @@ -0,0 +1,316 @@ +# IngestionPipelineRun + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. | [optional] [readonly] +**BackupFrequencyType** | Pointer to **string** | Backup schedule interval of the Data Lake Pipeline. | [optional] [readonly] +**CreatedDate** | Pointer to **time.Time** | Timestamp that indicates when the pipeline run was created. | [optional] [readonly] +**DatasetName** | Pointer to **string** | Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**LastUpdatedDate** | Pointer to **time.Time** | Timestamp that indicates the last time that the pipeline run was updated. | [optional] [readonly] +**Phase** | Pointer to **string** | Processing phase of the Data Lake Pipeline. | [optional] [readonly] +**PipelineId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies a Data Lake Pipeline. | [optional] [readonly] +**SnapshotId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the snapshot of a cluster. | [optional] [readonly] +**State** | Pointer to **string** | State of the pipeline run. | [optional] [readonly] +**Stats** | Pointer to [**PipelineRunStats**](PipelineRunStats.md) | | [optional] + +## Methods + +### NewIngestionPipelineRun + +`func NewIngestionPipelineRun() *IngestionPipelineRun` + +NewIngestionPipelineRun instantiates a new IngestionPipelineRun object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIngestionPipelineRunWithDefaults + +`func NewIngestionPipelineRunWithDefaults() *IngestionPipelineRun` + +NewIngestionPipelineRunWithDefaults instantiates a new IngestionPipelineRun object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *IngestionPipelineRun) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IngestionPipelineRun) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IngestionPipelineRun) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IngestionPipelineRun) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetBackupFrequencyType + +`func (o *IngestionPipelineRun) GetBackupFrequencyType() string` + +GetBackupFrequencyType returns the BackupFrequencyType field if non-nil, zero value otherwise. + +### GetBackupFrequencyTypeOk + +`func (o *IngestionPipelineRun) GetBackupFrequencyTypeOk() (*string, bool)` + +GetBackupFrequencyTypeOk returns a tuple with the BackupFrequencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupFrequencyType + +`func (o *IngestionPipelineRun) SetBackupFrequencyType(v string)` + +SetBackupFrequencyType sets BackupFrequencyType field to given value. + +### HasBackupFrequencyType + +`func (o *IngestionPipelineRun) HasBackupFrequencyType() bool` + +HasBackupFrequencyType returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *IngestionPipelineRun) GetCreatedDate() time.Time` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *IngestionPipelineRun) GetCreatedDateOk() (*time.Time, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *IngestionPipelineRun) SetCreatedDate(v time.Time)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *IngestionPipelineRun) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetDatasetName + +`func (o *IngestionPipelineRun) GetDatasetName() string` + +GetDatasetName returns the DatasetName field if non-nil, zero value otherwise. + +### GetDatasetNameOk + +`func (o *IngestionPipelineRun) GetDatasetNameOk() (*string, bool)` + +GetDatasetNameOk returns a tuple with the DatasetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatasetName + +`func (o *IngestionPipelineRun) SetDatasetName(v string)` + +SetDatasetName sets DatasetName field to given value. + +### HasDatasetName + +`func (o *IngestionPipelineRun) HasDatasetName() bool` + +HasDatasetName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *IngestionPipelineRun) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *IngestionPipelineRun) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *IngestionPipelineRun) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *IngestionPipelineRun) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetLastUpdatedDate + +`func (o *IngestionPipelineRun) GetLastUpdatedDate() time.Time` + +GetLastUpdatedDate returns the LastUpdatedDate field if non-nil, zero value otherwise. + +### GetLastUpdatedDateOk + +`func (o *IngestionPipelineRun) GetLastUpdatedDateOk() (*time.Time, bool)` + +GetLastUpdatedDateOk returns a tuple with the LastUpdatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdatedDate + +`func (o *IngestionPipelineRun) SetLastUpdatedDate(v time.Time)` + +SetLastUpdatedDate sets LastUpdatedDate field to given value. + +### HasLastUpdatedDate + +`func (o *IngestionPipelineRun) HasLastUpdatedDate() bool` + +HasLastUpdatedDate returns a boolean if a field has been set. + +### GetPhase + +`func (o *IngestionPipelineRun) GetPhase() string` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *IngestionPipelineRun) GetPhaseOk() (*string, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *IngestionPipelineRun) SetPhase(v string)` + +SetPhase sets Phase field to given value. + +### HasPhase + +`func (o *IngestionPipelineRun) HasPhase() bool` + +HasPhase returns a boolean if a field has been set. + +### GetPipelineId + +`func (o *IngestionPipelineRun) GetPipelineId() string` + +GetPipelineId returns the PipelineId field if non-nil, zero value otherwise. + +### GetPipelineIdOk + +`func (o *IngestionPipelineRun) GetPipelineIdOk() (*string, bool)` + +GetPipelineIdOk returns a tuple with the PipelineId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPipelineId + +`func (o *IngestionPipelineRun) SetPipelineId(v string)` + +SetPipelineId sets PipelineId field to given value. + +### HasPipelineId + +`func (o *IngestionPipelineRun) HasPipelineId() bool` + +HasPipelineId returns a boolean if a field has been set. + +### GetSnapshotId + +`func (o *IngestionPipelineRun) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *IngestionPipelineRun) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *IngestionPipelineRun) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + +### HasSnapshotId + +`func (o *IngestionPipelineRun) HasSnapshotId() bool` + +HasSnapshotId returns a boolean if a field has been set. + +### GetState + +`func (o *IngestionPipelineRun) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *IngestionPipelineRun) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *IngestionPipelineRun) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *IngestionPipelineRun) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetStats + +`func (o *IngestionPipelineRun) GetStats() PipelineRunStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *IngestionPipelineRun) GetStatsOk() (*PipelineRunStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *IngestionPipelineRun) SetStats(v PipelineRunStats)` + +SetStats sets Stats field to given value. + +### HasStats + +`func (o *IngestionPipelineRun) HasStats() bool` + +HasStats returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IngestionSink.md b/docs/docs/IngestionSink.md new file mode 100644 index 00000000..9925b991 --- /dev/null +++ b/docs/docs/IngestionSink.md @@ -0,0 +1,134 @@ +# IngestionSink + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetadataProvider** | Pointer to **string** | Target cloud provider for this Data Lake Pipeline. | [optional] +**MetadataRegion** | Pointer to **string** | Target cloud provider region for this Data Lake Pipeline. | [optional] +**PartitionFields** | Pointer to [**[]PartitionField**](PartitionField.md) | Ordered fields used to physically organize data in the destination. | [optional] +**Type** | Pointer to **string** | Type of ingestion destination of this Data Lake Pipeline. | [optional] + +## Methods + +### NewIngestionSink + +`func NewIngestionSink() *IngestionSink` + +NewIngestionSink instantiates a new IngestionSink object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIngestionSinkWithDefaults + +`func NewIngestionSinkWithDefaults() *IngestionSink` + +NewIngestionSinkWithDefaults instantiates a new IngestionSink object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadataProvider + +`func (o *IngestionSink) GetMetadataProvider() string` + +GetMetadataProvider returns the MetadataProvider field if non-nil, zero value otherwise. + +### GetMetadataProviderOk + +`func (o *IngestionSink) GetMetadataProviderOk() (*string, bool)` + +GetMetadataProviderOk returns a tuple with the MetadataProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadataProvider + +`func (o *IngestionSink) SetMetadataProvider(v string)` + +SetMetadataProvider sets MetadataProvider field to given value. + +### HasMetadataProvider + +`func (o *IngestionSink) HasMetadataProvider() bool` + +HasMetadataProvider returns a boolean if a field has been set. + +### GetMetadataRegion + +`func (o *IngestionSink) GetMetadataRegion() string` + +GetMetadataRegion returns the MetadataRegion field if non-nil, zero value otherwise. + +### GetMetadataRegionOk + +`func (o *IngestionSink) GetMetadataRegionOk() (*string, bool)` + +GetMetadataRegionOk returns a tuple with the MetadataRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadataRegion + +`func (o *IngestionSink) SetMetadataRegion(v string)` + +SetMetadataRegion sets MetadataRegion field to given value. + +### HasMetadataRegion + +`func (o *IngestionSink) HasMetadataRegion() bool` + +HasMetadataRegion returns a boolean if a field has been set. + +### GetPartitionFields + +`func (o *IngestionSink) GetPartitionFields() []PartitionField` + +GetPartitionFields returns the PartitionFields field if non-nil, zero value otherwise. + +### GetPartitionFieldsOk + +`func (o *IngestionSink) GetPartitionFieldsOk() (*[]PartitionField, bool)` + +GetPartitionFieldsOk returns a tuple with the PartitionFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartitionFields + +`func (o *IngestionSink) SetPartitionFields(v []PartitionField)` + +SetPartitionFields sets PartitionFields field to given value. + +### HasPartitionFields + +`func (o *IngestionSink) HasPartitionFields() bool` + +HasPartitionFields returns a boolean if a field has been set. + +### GetType + +`func (o *IngestionSink) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IngestionSink) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IngestionSink) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IngestionSink) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/IngestionSource.md b/docs/docs/IngestionSource.md new file mode 100644 index 00000000..cc4fd1d3 --- /dev/null +++ b/docs/docs/IngestionSource.md @@ -0,0 +1,186 @@ +# IngestionSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | Pointer to **string** | Human-readable name that identifies the cluster. | [optional] +**CollectionName** | Pointer to **string** | Human-readable name that identifies the collection. | [optional] +**DatabaseName** | Pointer to **string** | Human-readable name that identifies the database. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**Type** | Pointer to **string** | Type of ingestion source of this Data Lake Pipeline. | [optional] +**PolicyItemId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies a policy item. | [optional] + +## Methods + +### NewIngestionSource + +`func NewIngestionSource() *IngestionSource` + +NewIngestionSource instantiates a new IngestionSource object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIngestionSourceWithDefaults + +`func NewIngestionSourceWithDefaults() *IngestionSource` + +NewIngestionSourceWithDefaults instantiates a new IngestionSource object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *IngestionSource) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *IngestionSource) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *IngestionSource) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *IngestionSource) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCollectionName + +`func (o *IngestionSource) GetCollectionName() string` + +GetCollectionName returns the CollectionName field if non-nil, zero value otherwise. + +### GetCollectionNameOk + +`func (o *IngestionSource) GetCollectionNameOk() (*string, bool)` + +GetCollectionNameOk returns a tuple with the CollectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionName + +`func (o *IngestionSource) SetCollectionName(v string)` + +SetCollectionName sets CollectionName field to given value. + +### HasCollectionName + +`func (o *IngestionSource) HasCollectionName() bool` + +HasCollectionName returns a boolean if a field has been set. + +### GetDatabaseName + +`func (o *IngestionSource) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *IngestionSource) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *IngestionSource) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + +### HasDatabaseName + +`func (o *IngestionSource) HasDatabaseName() bool` + +HasDatabaseName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *IngestionSource) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *IngestionSource) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *IngestionSource) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *IngestionSource) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetType + +`func (o *IngestionSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IngestionSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IngestionSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IngestionSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPolicyItemId + +`func (o *IngestionSource) GetPolicyItemId() string` + +GetPolicyItemId returns the PolicyItemId field if non-nil, zero value otherwise. + +### GetPolicyItemIdOk + +`func (o *IngestionSource) GetPolicyItemIdOk() (*string, bool)` + +GetPolicyItemIdOk returns a tuple with the PolicyItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyItemId + +`func (o *IngestionSource) SetPolicyItemId(v string)` + +SetPolicyItemId sets PolicyItemId field to given value. + +### HasPolicyItemId + +`func (o *IngestionSource) HasPolicyItemId() bool` + +HasPolicyItemId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/InheritedRole.md b/docs/docs/InheritedRole.md new file mode 100644 index 00000000..87c69d0d --- /dev/null +++ b/docs/docs/InheritedRole.md @@ -0,0 +1,72 @@ +# InheritedRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Db** | **string** | Human-readable label that identifies the database on which someone grants the action to one MongoDB user. | +**Role** | **string** | Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`. | + +## Methods + +### NewInheritedRole + +`func NewInheritedRole(db string, role string, ) *InheritedRole` + +NewInheritedRole instantiates a new InheritedRole object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewInheritedRoleWithDefaults + +`func NewInheritedRoleWithDefaults() *InheritedRole` + +NewInheritedRoleWithDefaults instantiates a new InheritedRole object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDb + +`func (o *InheritedRole) GetDb() string` + +GetDb returns the Db field if non-nil, zero value otherwise. + +### GetDbOk + +`func (o *InheritedRole) GetDbOk() (*string, bool)` + +GetDbOk returns a tuple with the Db field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDb + +`func (o *InheritedRole) SetDb(v string)` + +SetDb sets Db field to given value. + + +### GetRole + +`func (o *InheritedRole) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *InheritedRole) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *InheritedRole) SetRole(v string)` + +SetRole sets Role field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/InstanceSize.md b/docs/docs/InstanceSize.md new file mode 100644 index 00000000..c12087f4 --- /dev/null +++ b/docs/docs/InstanceSize.md @@ -0,0 +1,71 @@ +# InstanceSize + +## Enum + + +* `M10` (value: `"M10"`) + +* `M20` (value: `"M20"`) + +* `M30` (value: `"M30"`) + +* `M40` (value: `"M40"`) + +* `M50` (value: `"M50"`) + +* `M60` (value: `"M60"`) + +* `M80` (value: `"M80"`) + +* `M100` (value: `"M100"`) + +* `M140` (value: `"M140"`) + +* `M200` (value: `"M200"`) + +* `M300` (value: `"M300"`) + +* `R40` (value: `"R40"`) + +* `R50` (value: `"R50"`) + +* `R60` (value: `"R60"`) + +* `R80` (value: `"R80"`) + +* `R200` (value: `"R200"`) + +* `R300` (value: `"R300"`) + +* `R400` (value: `"R400"`) + +* `R700` (value: `"R700"`) + +* `M40_NVME` (value: `"M40_NVME"`) + +* `M50_NVME` (value: `"M50_NVME"`) + +* `M60_NVME` (value: `"M60_NVME"`) + +* `M80_NVME` (value: `"M80_NVME"`) + +* `M200_NVME` (value: `"M200_NVME"`) + +* `M400_NVME` (value: `"M400_NVME"`) + +* `M90` (value: `"M90"`) + +* `M300_NVME` (value: `"M300_NVME"`) + +* `M600_NVME` (value: `"M600_NVME"`) + +* `M250` (value: `"M250"`) + +* `M400` (value: `"M400"`) + +* `R600` (value: `"R600"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Integration.md b/docs/docs/Integration.md new file mode 100644 index 00000000..a954d0fc --- /dev/null +++ b/docs/docs/Integration.md @@ -0,0 +1,568 @@ +# Integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | **string** | Key that allows MongoDB Cloud to access your VictorOps account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | +**Region** | Pointer to **string** | PagerDuty region that indicates the API Uniform Resource Locator (URL) to use. | [optional] +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] +**MicrosoftTeamsWebhookUrl** | **string** | Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications. **NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted. | +**AccountId** | **string** | Unique 40-hexadecimal digit string that identifies your New Relic account. | +**LicenseKey** | **string** | Unique 40-hexadecimal digit string that identifies your New Relic license. **IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration. To learn more, see the <a href=\"https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267\" target=\"_blank\">New Relic Plugin EOL Statement</a> Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments. | +**ReadToken** | **string** | Query key used to access your New Relic account. | +**WriteToken** | **string** | Insert key associated with your New Relic account. | +**ServiceKey** | **string** | Service key associated with your PagerDuty account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | +**Enabled** | **bool** | Flag that indicates whether someone has activated the Prometheus integration. | +**ListenAddress** | Pointer to **string** | Combination of IPv4 address and Internet Assigned Numbers Authority (IANA) port or the IANA port alone to which Prometheus binds to ingest MongoDB metrics. | [optional] [default to ":9216"] +**Password** | Pointer to **string** | | [optional] +**RateLimitInterval** | Pointer to **int** | | [optional] +**Scheme** | **string** | Security Scheme to apply to HyperText Transfer Protocol (HTTP) traffic between Prometheus and MongoDB Cloud. | +**ServiceDiscovery** | **string** | Desired method to discover the Prometheus service. | +**TlsPemPath** | Pointer to **string** | Root-relative path to the Transport Layer Security (TLS) Privacy Enhanced Mail (PEM) key and certificate file on the host. | [optional] +**Username** | **string** | Human-readable label that identifies your Prometheus incoming webhook. | +**ApiToken** | **string** | Key that allows MongoDB Cloud to access your Slack account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. **IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported. | +**ChannelName** | **NullableString** | Name of the Slack channel to which MongoDB Cloud sends alert notifications. | +**TeamName** | Pointer to **string** | Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration. | [optional] +**RoutingKey** | Pointer to **string** | Routing key associated with your Splunk On-Call account. | [optional] +**Secret** | Pointer to **string** | An optional field returned if your webhook is configured with a secret. **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted. | [optional] +**Url** | **string** | Endpoint web address to which MongoDB Cloud sends notifications. **NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted. | + +## Methods + +### NewIntegration + +`func NewIntegration(apiKey string, microsoftTeamsWebhookUrl string, accountId string, licenseKey string, readToken string, writeToken string, serviceKey string, enabled bool, scheme string, serviceDiscovery string, username string, apiToken string, channelName NullableString, url string, ) *Integration` + +NewIntegration instantiates a new Integration object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIntegrationWithDefaults + +`func NewIntegrationWithDefaults() *Integration` + +NewIntegrationWithDefaults instantiates a new Integration object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKey + +`func (o *Integration) GetApiKey() string` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *Integration) GetApiKeyOk() (*string, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *Integration) SetApiKey(v string)` + +SetApiKey sets ApiKey field to given value. + + +### GetRegion + +`func (o *Integration) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *Integration) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *Integration) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *Integration) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetType + +`func (o *Integration) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Integration) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Integration) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Integration) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetMicrosoftTeamsWebhookUrl + +`func (o *Integration) GetMicrosoftTeamsWebhookUrl() string` + +GetMicrosoftTeamsWebhookUrl returns the MicrosoftTeamsWebhookUrl field if non-nil, zero value otherwise. + +### GetMicrosoftTeamsWebhookUrlOk + +`func (o *Integration) GetMicrosoftTeamsWebhookUrlOk() (*string, bool)` + +GetMicrosoftTeamsWebhookUrlOk returns a tuple with the MicrosoftTeamsWebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMicrosoftTeamsWebhookUrl + +`func (o *Integration) SetMicrosoftTeamsWebhookUrl(v string)` + +SetMicrosoftTeamsWebhookUrl sets MicrosoftTeamsWebhookUrl field to given value. + + +### GetAccountId + +`func (o *Integration) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *Integration) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *Integration) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + + +### GetLicenseKey + +`func (o *Integration) GetLicenseKey() string` + +GetLicenseKey returns the LicenseKey field if non-nil, zero value otherwise. + +### GetLicenseKeyOk + +`func (o *Integration) GetLicenseKeyOk() (*string, bool)` + +GetLicenseKeyOk returns a tuple with the LicenseKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenseKey + +`func (o *Integration) SetLicenseKey(v string)` + +SetLicenseKey sets LicenseKey field to given value. + + +### GetReadToken + +`func (o *Integration) GetReadToken() string` + +GetReadToken returns the ReadToken field if non-nil, zero value otherwise. + +### GetReadTokenOk + +`func (o *Integration) GetReadTokenOk() (*string, bool)` + +GetReadTokenOk returns a tuple with the ReadToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadToken + +`func (o *Integration) SetReadToken(v string)` + +SetReadToken sets ReadToken field to given value. + + +### GetWriteToken + +`func (o *Integration) GetWriteToken() string` + +GetWriteToken returns the WriteToken field if non-nil, zero value otherwise. + +### GetWriteTokenOk + +`func (o *Integration) GetWriteTokenOk() (*string, bool)` + +GetWriteTokenOk returns a tuple with the WriteToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWriteToken + +`func (o *Integration) SetWriteToken(v string)` + +SetWriteToken sets WriteToken field to given value. + + +### GetServiceKey + +`func (o *Integration) GetServiceKey() string` + +GetServiceKey returns the ServiceKey field if non-nil, zero value otherwise. + +### GetServiceKeyOk + +`func (o *Integration) GetServiceKeyOk() (*string, bool)` + +GetServiceKeyOk returns a tuple with the ServiceKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceKey + +`func (o *Integration) SetServiceKey(v string)` + +SetServiceKey sets ServiceKey field to given value. + + +### GetEnabled + +`func (o *Integration) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Integration) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Integration) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetListenAddress + +`func (o *Integration) GetListenAddress() string` + +GetListenAddress returns the ListenAddress field if non-nil, zero value otherwise. + +### GetListenAddressOk + +`func (o *Integration) GetListenAddressOk() (*string, bool)` + +GetListenAddressOk returns a tuple with the ListenAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetListenAddress + +`func (o *Integration) SetListenAddress(v string)` + +SetListenAddress sets ListenAddress field to given value. + +### HasListenAddress + +`func (o *Integration) HasListenAddress() bool` + +HasListenAddress returns a boolean if a field has been set. + +### GetPassword + +`func (o *Integration) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *Integration) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *Integration) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *Integration) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetRateLimitInterval + +`func (o *Integration) GetRateLimitInterval() int` + +GetRateLimitInterval returns the RateLimitInterval field if non-nil, zero value otherwise. + +### GetRateLimitIntervalOk + +`func (o *Integration) GetRateLimitIntervalOk() (*int, bool)` + +GetRateLimitIntervalOk returns a tuple with the RateLimitInterval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRateLimitInterval + +`func (o *Integration) SetRateLimitInterval(v int)` + +SetRateLimitInterval sets RateLimitInterval field to given value. + +### HasRateLimitInterval + +`func (o *Integration) HasRateLimitInterval() bool` + +HasRateLimitInterval returns a boolean if a field has been set. + +### GetScheme + +`func (o *Integration) GetScheme() string` + +GetScheme returns the Scheme field if non-nil, zero value otherwise. + +### GetSchemeOk + +`func (o *Integration) GetSchemeOk() (*string, bool)` + +GetSchemeOk returns a tuple with the Scheme field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheme + +`func (o *Integration) SetScheme(v string)` + +SetScheme sets Scheme field to given value. + + +### GetServiceDiscovery + +`func (o *Integration) GetServiceDiscovery() string` + +GetServiceDiscovery returns the ServiceDiscovery field if non-nil, zero value otherwise. + +### GetServiceDiscoveryOk + +`func (o *Integration) GetServiceDiscoveryOk() (*string, bool)` + +GetServiceDiscoveryOk returns a tuple with the ServiceDiscovery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceDiscovery + +`func (o *Integration) SetServiceDiscovery(v string)` + +SetServiceDiscovery sets ServiceDiscovery field to given value. + + +### GetTlsPemPath + +`func (o *Integration) GetTlsPemPath() string` + +GetTlsPemPath returns the TlsPemPath field if non-nil, zero value otherwise. + +### GetTlsPemPathOk + +`func (o *Integration) GetTlsPemPathOk() (*string, bool)` + +GetTlsPemPathOk returns a tuple with the TlsPemPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTlsPemPath + +`func (o *Integration) SetTlsPemPath(v string)` + +SetTlsPemPath sets TlsPemPath field to given value. + +### HasTlsPemPath + +`func (o *Integration) HasTlsPemPath() bool` + +HasTlsPemPath returns a boolean if a field has been set. + +### GetUsername + +`func (o *Integration) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *Integration) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *Integration) SetUsername(v string)` + +SetUsername sets Username field to given value. + + +### GetApiToken + +`func (o *Integration) GetApiToken() string` + +GetApiToken returns the ApiToken field if non-nil, zero value otherwise. + +### GetApiTokenOk + +`func (o *Integration) GetApiTokenOk() (*string, bool)` + +GetApiTokenOk returns a tuple with the ApiToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiToken + +`func (o *Integration) SetApiToken(v string)` + +SetApiToken sets ApiToken field to given value. + + +### GetChannelName + +`func (o *Integration) GetChannelName() string` + +GetChannelName returns the ChannelName field if non-nil, zero value otherwise. + +### GetChannelNameOk + +`func (o *Integration) GetChannelNameOk() (*string, bool)` + +GetChannelNameOk returns a tuple with the ChannelName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChannelName + +`func (o *Integration) SetChannelName(v string)` + +SetChannelName sets ChannelName field to given value. + + +### SetChannelNameNil + +`func (o *Integration) SetChannelNameNil(b bool)` + + SetChannelNameNil sets the value for ChannelName to be an explicit nil + +### UnsetChannelName +`func (o *Integration) UnsetChannelName()` + +UnsetChannelName ensures that no value is present for ChannelName, not even an explicit nil +### GetTeamName + +`func (o *Integration) GetTeamName() string` + +GetTeamName returns the TeamName field if non-nil, zero value otherwise. + +### GetTeamNameOk + +`func (o *Integration) GetTeamNameOk() (*string, bool)` + +GetTeamNameOk returns a tuple with the TeamName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamName + +`func (o *Integration) SetTeamName(v string)` + +SetTeamName sets TeamName field to given value. + +### HasTeamName + +`func (o *Integration) HasTeamName() bool` + +HasTeamName returns a boolean if a field has been set. + +### GetRoutingKey + +`func (o *Integration) GetRoutingKey() string` + +GetRoutingKey returns the RoutingKey field if non-nil, zero value otherwise. + +### GetRoutingKeyOk + +`func (o *Integration) GetRoutingKeyOk() (*string, bool)` + +GetRoutingKeyOk returns a tuple with the RoutingKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoutingKey + +`func (o *Integration) SetRoutingKey(v string)` + +SetRoutingKey sets RoutingKey field to given value. + +### HasRoutingKey + +`func (o *Integration) HasRoutingKey() bool` + +HasRoutingKey returns a boolean if a field has been set. + +### GetSecret + +`func (o *Integration) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *Integration) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *Integration) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *Integration) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetUrl + +`func (o *Integration) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *Integration) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *Integration) SetUrl(v string)` + +SetUrl sets Url field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Invoice.md b/docs/docs/Invoice.md new file mode 100644 index 00000000..c5ad82f0 --- /dev/null +++ b/docs/docs/Invoice.md @@ -0,0 +1,524 @@ +# Invoice + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AmountBilledCents** | Pointer to **int64** | Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar) and calculates its value as **subtotalCents** + **salesTaxCents** - **startingBalanceCents**. | [optional] [readonly] +**AmountPaidCents** | Pointer to **int64** | Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar). | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**CreditsCents** | Pointer to **int64** | Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar). | [optional] [readonly] +**EndDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project associated to this invoice. This identifying string doesn't appear on all invoices. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. | [optional] [readonly] +**LineItems** | Pointer to [**[]LineItem**](LineItem.md) | List that contains individual services included in this invoice. | [optional] [readonly] +**LinkedInvoices** | Pointer to [**[]Invoice**](Invoice.md) | List that contains the invoices for organizations linked to the paying organization. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud. | [optional] [readonly] +**Payments** | Pointer to [**[]Payment**](Payment.md) | List that contains funds transferred to MongoDB to cover the specified service noted in this invoice. | [optional] [readonly] +**Refunds** | Pointer to [**[]Refund**](Refund.md) | List that contains payments that MongoDB returned to the organization for this invoice. | [optional] [readonly] +**SalesTaxCents** | Pointer to **int64** | Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar). | [optional] [readonly] +**StartDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**StartingBalanceCents** | Pointer to **int64** | Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars. | [optional] [readonly] +**StatusName** | Pointer to **string** | Phase of payment processing in which this invoice exists when you made this request. Accepted phases include: | Phase Value | Reason | |---|---| | CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. | | FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. | | FORGIVEN | Customer initiated payment which MongoDB later forgave. | | FREE | All charges totalled zero so the customer won't be charged. | | INVOICED | MongoDB handled these charges using elastic invoicing. | | PAID | MongoDB succeeded in charging the provided credit card. | | PENDING | Invoice includes charges for the current billing cycle. | | PREPAID | Customer has a pre-paid plan so they won't be charged. | | [optional] +**SubtotalCents** | Pointer to **int64** | Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar). | [optional] [readonly] +**Updated** | Pointer to **time.Time** | Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewInvoice + +`func NewInvoice() *Invoice` + +NewInvoice instantiates a new Invoice object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewInvoiceWithDefaults + +`func NewInvoiceWithDefaults() *Invoice` + +NewInvoiceWithDefaults instantiates a new Invoice object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAmountBilledCents + +`func (o *Invoice) GetAmountBilledCents() int64` + +GetAmountBilledCents returns the AmountBilledCents field if non-nil, zero value otherwise. + +### GetAmountBilledCentsOk + +`func (o *Invoice) GetAmountBilledCentsOk() (*int64, bool)` + +GetAmountBilledCentsOk returns a tuple with the AmountBilledCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmountBilledCents + +`func (o *Invoice) SetAmountBilledCents(v int64)` + +SetAmountBilledCents sets AmountBilledCents field to given value. + +### HasAmountBilledCents + +`func (o *Invoice) HasAmountBilledCents() bool` + +HasAmountBilledCents returns a boolean if a field has been set. + +### GetAmountPaidCents + +`func (o *Invoice) GetAmountPaidCents() int64` + +GetAmountPaidCents returns the AmountPaidCents field if non-nil, zero value otherwise. + +### GetAmountPaidCentsOk + +`func (o *Invoice) GetAmountPaidCentsOk() (*int64, bool)` + +GetAmountPaidCentsOk returns a tuple with the AmountPaidCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmountPaidCents + +`func (o *Invoice) SetAmountPaidCents(v int64)` + +SetAmountPaidCents sets AmountPaidCents field to given value. + +### HasAmountPaidCents + +`func (o *Invoice) HasAmountPaidCents() bool` + +HasAmountPaidCents returns a boolean if a field has been set. + +### GetCreated + +`func (o *Invoice) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Invoice) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Invoice) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Invoice) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreditsCents + +`func (o *Invoice) GetCreditsCents() int64` + +GetCreditsCents returns the CreditsCents field if non-nil, zero value otherwise. + +### GetCreditsCentsOk + +`func (o *Invoice) GetCreditsCentsOk() (*int64, bool)` + +GetCreditsCentsOk returns a tuple with the CreditsCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreditsCents + +`func (o *Invoice) SetCreditsCents(v int64)` + +SetCreditsCents sets CreditsCents field to given value. + +### HasCreditsCents + +`func (o *Invoice) HasCreditsCents() bool` + +HasCreditsCents returns a boolean if a field has been set. + +### GetEndDate + +`func (o *Invoice) GetEndDate() time.Time` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *Invoice) GetEndDateOk() (*time.Time, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *Invoice) SetEndDate(v time.Time)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *Invoice) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetGroupId + +`func (o *Invoice) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *Invoice) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *Invoice) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *Invoice) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *Invoice) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Invoice) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Invoice) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Invoice) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLineItems + +`func (o *Invoice) GetLineItems() []LineItem` + +GetLineItems returns the LineItems field if non-nil, zero value otherwise. + +### GetLineItemsOk + +`func (o *Invoice) GetLineItemsOk() (*[]LineItem, bool)` + +GetLineItemsOk returns a tuple with the LineItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLineItems + +`func (o *Invoice) SetLineItems(v []LineItem)` + +SetLineItems sets LineItems field to given value. + +### HasLineItems + +`func (o *Invoice) HasLineItems() bool` + +HasLineItems returns a boolean if a field has been set. + +### GetLinkedInvoices + +`func (o *Invoice) GetLinkedInvoices() []Invoice` + +GetLinkedInvoices returns the LinkedInvoices field if non-nil, zero value otherwise. + +### GetLinkedInvoicesOk + +`func (o *Invoice) GetLinkedInvoicesOk() (*[]Invoice, bool)` + +GetLinkedInvoicesOk returns a tuple with the LinkedInvoices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinkedInvoices + +`func (o *Invoice) SetLinkedInvoices(v []Invoice)` + +SetLinkedInvoices sets LinkedInvoices field to given value. + +### HasLinkedInvoices + +`func (o *Invoice) HasLinkedInvoices() bool` + +HasLinkedInvoices returns a boolean if a field has been set. + +### GetLinks + +`func (o *Invoice) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Invoice) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Invoice) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Invoice) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *Invoice) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *Invoice) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *Invoice) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *Invoice) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPayments + +`func (o *Invoice) GetPayments() []Payment` + +GetPayments returns the Payments field if non-nil, zero value otherwise. + +### GetPaymentsOk + +`func (o *Invoice) GetPaymentsOk() (*[]Payment, bool)` + +GetPaymentsOk returns a tuple with the Payments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayments + +`func (o *Invoice) SetPayments(v []Payment)` + +SetPayments sets Payments field to given value. + +### HasPayments + +`func (o *Invoice) HasPayments() bool` + +HasPayments returns a boolean if a field has been set. + +### GetRefunds + +`func (o *Invoice) GetRefunds() []Refund` + +GetRefunds returns the Refunds field if non-nil, zero value otherwise. + +### GetRefundsOk + +`func (o *Invoice) GetRefundsOk() (*[]Refund, bool)` + +GetRefundsOk returns a tuple with the Refunds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefunds + +`func (o *Invoice) SetRefunds(v []Refund)` + +SetRefunds sets Refunds field to given value. + +### HasRefunds + +`func (o *Invoice) HasRefunds() bool` + +HasRefunds returns a boolean if a field has been set. + +### GetSalesTaxCents + +`func (o *Invoice) GetSalesTaxCents() int64` + +GetSalesTaxCents returns the SalesTaxCents field if non-nil, zero value otherwise. + +### GetSalesTaxCentsOk + +`func (o *Invoice) GetSalesTaxCentsOk() (*int64, bool)` + +GetSalesTaxCentsOk returns a tuple with the SalesTaxCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSalesTaxCents + +`func (o *Invoice) SetSalesTaxCents(v int64)` + +SetSalesTaxCents sets SalesTaxCents field to given value. + +### HasSalesTaxCents + +`func (o *Invoice) HasSalesTaxCents() bool` + +HasSalesTaxCents returns a boolean if a field has been set. + +### GetStartDate + +`func (o *Invoice) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *Invoice) GetStartDateOk() (*time.Time, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *Invoice) SetStartDate(v time.Time)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *Invoice) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetStartingBalanceCents + +`func (o *Invoice) GetStartingBalanceCents() int64` + +GetStartingBalanceCents returns the StartingBalanceCents field if non-nil, zero value otherwise. + +### GetStartingBalanceCentsOk + +`func (o *Invoice) GetStartingBalanceCentsOk() (*int64, bool)` + +GetStartingBalanceCentsOk returns a tuple with the StartingBalanceCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartingBalanceCents + +`func (o *Invoice) SetStartingBalanceCents(v int64)` + +SetStartingBalanceCents sets StartingBalanceCents field to given value. + +### HasStartingBalanceCents + +`func (o *Invoice) HasStartingBalanceCents() bool` + +HasStartingBalanceCents returns a boolean if a field has been set. + +### GetStatusName + +`func (o *Invoice) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *Invoice) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *Invoice) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *Invoice) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetSubtotalCents + +`func (o *Invoice) GetSubtotalCents() int64` + +GetSubtotalCents returns the SubtotalCents field if non-nil, zero value otherwise. + +### GetSubtotalCentsOk + +`func (o *Invoice) GetSubtotalCentsOk() (*int64, bool)` + +GetSubtotalCentsOk returns a tuple with the SubtotalCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtotalCents + +`func (o *Invoice) SetSubtotalCents(v int64)` + +SetSubtotalCents sets SubtotalCents field to given value. + +### HasSubtotalCents + +`func (o *Invoice) HasSubtotalCents() bool` + +HasSubtotalCents returns a boolean if a field has been set. + +### GetUpdated + +`func (o *Invoice) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *Invoice) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *Invoice) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *Invoice) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/InvoicesApi.md b/docs/docs/InvoicesApi.md new file mode 100644 index 00000000..ac90167e --- /dev/null +++ b/docs/docs/InvoicesApi.md @@ -0,0 +1,318 @@ +# \InvoicesApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**DownloadInvoiceCSV**](InvoicesApi.md#DownloadInvoiceCSV) | **Get** /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv | Return One Organization Invoice as CSV +[**GetInvoice**](InvoicesApi.md#GetInvoice) | **Get** /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId} | Return One Organization Invoice +[**ListInvoices**](InvoicesApi.md#ListInvoices) | **Get** /api/atlas/v2/orgs/{orgId}/invoices | Return All Invoices for One Organization +[**ListPendingInvoices**](InvoicesApi.md#ListPendingInvoices) | **Get** /api/atlas/v2/orgs/{orgId}/invoices/pending | Return All Pending Invoices for One Organization + + + +## DownloadInvoiceCSV + +> DownloadInvoiceCSV(ctx, orgId, invoiceId).Execute() + +Return One Organization Invoice as CSV + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + invoiceId := "invoiceId_example" // string | + + r, err := sdk.InvoicesApi.DownloadInvoiceCSV(context.Background(), orgId, invoiceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `InvoicesApi.DownloadInvoiceCSV``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**invoiceId** | **string** | Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadInvoiceCSVRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+csv, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetInvoice + +> Invoice GetInvoice(ctx, orgId, invoiceId).Execute() + +Return One Organization Invoice + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + invoiceId := "invoiceId_example" // string | + + resp, r, err := sdk.InvoicesApi.GetInvoice(context.Background(), orgId, invoiceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `InvoicesApi.GetInvoice``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetInvoice`: Invoice + fmt.Fprintf(os.Stdout, "Response from `InvoicesApi.GetInvoice`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**invoiceId** | **string** | Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetInvoiceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Invoice**](Invoice.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListInvoices + +> PaginatedApiInvoice ListInvoices(ctx, orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Invoices for One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.InvoicesApi.ListInvoices(context.Background(), orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `InvoicesApi.ListInvoices``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListInvoices`: PaginatedApiInvoice + fmt.Fprintf(os.Stdout, "Response from `InvoicesApi.ListInvoices`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListInvoicesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiInvoice**](PaginatedApiInvoice.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPendingInvoices + +> PaginatedApiInvoice ListPendingInvoices(ctx, orgId).Execute() + +Return All Pending Invoices for One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + + resp, r, err := sdk.InvoicesApi.ListPendingInvoices(context.Background(), orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `InvoicesApi.ListPendingInvoices``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPendingInvoices`: PaginatedApiInvoice + fmt.Fprintf(os.Stdout, "Response from `InvoicesApi.ListPendingInvoices`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPendingInvoicesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PaginatedApiInvoice**](PaginatedApiInvoice.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/Key.md b/docs/docs/Key.md new file mode 100644 index 00000000..307aa89e --- /dev/null +++ b/docs/docs/Key.md @@ -0,0 +1,124 @@ +# Key + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessList** | Pointer to [**[]AccessListItem**](AccessListItem.md) | List of network addresses granted access to this API using this API key. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key. | [readonly] +**PublicKey** | **string** | Public API key value set for the specified organization API key. | [readonly] +**Roles** | Pointer to [**[]RoleAssignment**](RoleAssignment.md) | List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user. | [optional] [readonly] + +## Methods + +### NewKey + +`func NewKey(id string, publicKey string, ) *Key` + +NewKey instantiates a new Key object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewKeyWithDefaults + +`func NewKeyWithDefaults() *Key` + +NewKeyWithDefaults instantiates a new Key object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessList + +`func (o *Key) GetAccessList() []AccessListItem` + +GetAccessList returns the AccessList field if non-nil, zero value otherwise. + +### GetAccessListOk + +`func (o *Key) GetAccessListOk() (*[]AccessListItem, bool)` + +GetAccessListOk returns a tuple with the AccessList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessList + +`func (o *Key) SetAccessList(v []AccessListItem)` + +SetAccessList sets AccessList field to given value. + +### HasAccessList + +`func (o *Key) HasAccessList() bool` + +HasAccessList returns a boolean if a field has been set. + +### GetId + +`func (o *Key) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Key) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Key) SetId(v string)` + +SetId sets Id field to given value. + + +### GetPublicKey + +`func (o *Key) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *Key) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *Key) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + + +### GetRoles + +`func (o *Key) GetRoles() []RoleAssignment` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *Key) GetRolesOk() (*[]RoleAssignment, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *Key) SetRoles(v []RoleAssignment)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *Key) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LDAPConfigurationApi.md b/docs/docs/LDAPConfigurationApi.md new file mode 100644 index 00000000..93b6b141 --- /dev/null +++ b/docs/docs/LDAPConfigurationApi.md @@ -0,0 +1,388 @@ +# \LDAPConfigurationApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**DeleteLDAPConfiguration**](LDAPConfigurationApi.md#DeleteLDAPConfiguration) | **Delete** /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping | Remove the Current LDAP User to DN Mapping +[**GetLDAPConfiguration**](LDAPConfigurationApi.md#GetLDAPConfiguration) | **Get** /api/atlas/v2/groups/{groupId}/userSecurity | Return the Current LDAP or X.509 Configuration +[**GetLDAPConfigurationStatus**](LDAPConfigurationApi.md#GetLDAPConfigurationStatus) | **Get** /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId} | Return the Status of One Verify LDAP Configuration Request +[**SaveLDAPConfiguration**](LDAPConfigurationApi.md#SaveLDAPConfiguration) | **Patch** /api/atlas/v2/groups/{groupId}/userSecurity | Edit the LDAP or X.509 Configuration +[**VerifyLDAPConfiguration**](LDAPConfigurationApi.md#VerifyLDAPConfiguration) | **Post** /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify | Verify the LDAP Configuration in One Project + + + +## DeleteLDAPConfiguration + +> DeleteLDAPConfiguration(ctx, groupId).Execute() + +Remove the Current LDAP User to DN Mapping + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.LDAPConfigurationApi.DeleteLDAPConfiguration(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LDAPConfigurationApi.DeleteLDAPConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLDAPConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetLDAPConfiguration + +> UserSecurity GetLDAPConfiguration(ctx, groupId).Execute() + +Return the Current LDAP or X.509 Configuration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.LDAPConfigurationApi.GetLDAPConfiguration(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LDAPConfigurationApi.GetLDAPConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetLDAPConfiguration`: UserSecurity + fmt.Fprintf(os.Stdout, "Response from `LDAPConfigurationApi.GetLDAPConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLDAPConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**UserSecurity**](UserSecurity.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetLDAPConfigurationStatus + +> NDSLDAPVerifyConnectivityJobRequest GetLDAPConfigurationStatus(ctx, groupId, requestId).Execute() + +Return the Status of One Verify LDAP Configuration Request + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + requestId := "requestId_example" // string | + + resp, r, err := sdk.LDAPConfigurationApi.GetLDAPConfigurationStatus(context.Background(), groupId, requestId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LDAPConfigurationApi.GetLDAPConfigurationStatus``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetLDAPConfigurationStatus`: NDSLDAPVerifyConnectivityJobRequest + fmt.Fprintf(os.Stdout, "Response from `LDAPConfigurationApi.GetLDAPConfigurationStatus`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**requestId** | **string** | Unique string that identifies the request to verify an <abbr title=\"Lightweight Directory Access Protocol\">LDAP</abbr> configuration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLDAPConfigurationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NDSLDAPVerifyConnectivityJobRequest**](NDSLDAPVerifyConnectivityJobRequest.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## SaveLDAPConfiguration + +> UserSecurity SaveLDAPConfiguration(ctx, groupId).UserSecurity(userSecurity).Execute() + +Edit the LDAP or X.509 Configuration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + userSecurity := *openapiclient.NewUserSecurity() // UserSecurity | + + resp, r, err := sdk.LDAPConfigurationApi.SaveLDAPConfiguration(context.Background(), groupId).UserSecurity(userSecurity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LDAPConfigurationApi.SaveLDAPConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `SaveLDAPConfiguration`: UserSecurity + fmt.Fprintf(os.Stdout, "Response from `LDAPConfigurationApi.SaveLDAPConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSaveLDAPConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **userSecurity** | [**UserSecurity**](UserSecurity.md) | Updates the LDAP configuration for the specified project. | + +### Return type + +[**UserSecurity**](UserSecurity.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VerifyLDAPConfiguration + +> NDSLDAPVerifyConnectivityJobRequest VerifyLDAPConfiguration(ctx, groupId).NDSLDAPVerifyConnectivityJobRequestParams(nDSLDAPVerifyConnectivityJobRequestParams).Execute() + +Verify the LDAP Configuration in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + nDSLDAPVerifyConnectivityJobRequestParams := *openapiclient.NewNDSLDAPVerifyConnectivityJobRequestParams("BindPassword_example", "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", "Hostname_example", int(123)) // NDSLDAPVerifyConnectivityJobRequestParams | + + resp, r, err := sdk.LDAPConfigurationApi.VerifyLDAPConfiguration(context.Background(), groupId).NDSLDAPVerifyConnectivityJobRequestParams(nDSLDAPVerifyConnectivityJobRequestParams).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LDAPConfigurationApi.VerifyLDAPConfiguration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `VerifyLDAPConfiguration`: NDSLDAPVerifyConnectivityJobRequest + fmt.Fprintf(os.Stdout, "Response from `LDAPConfigurationApi.VerifyLDAPConfiguration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVerifyLDAPConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nDSLDAPVerifyConnectivityJobRequestParams** | [**NDSLDAPVerifyConnectivityJobRequestParams**](NDSLDAPVerifyConnectivityJobRequestParams.md) | The LDAP configuration for the specified project that you want to verify. | + +### Return type + +[**NDSLDAPVerifyConnectivityJobRequest**](NDSLDAPVerifyConnectivityJobRequest.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/Label.md b/docs/docs/Label.md new file mode 100644 index 00000000..741e90c1 --- /dev/null +++ b/docs/docs/Label.md @@ -0,0 +1,82 @@ +# Label + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. | [optional] +**Value** | Pointer to **string** | Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes. | [optional] + +## Methods + +### NewLabel + +`func NewLabel() *Label` + +NewLabel instantiates a new Label object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLabelWithDefaults + +`func NewLabelWithDefaults() *Label` + +NewLabelWithDefaults instantiates a new Label object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetKey + +`func (o *Label) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *Label) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *Label) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *Label) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValue + +`func (o *Label) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Label) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Label) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Label) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LegacyBackupApi.md b/docs/docs/LegacyBackupApi.md new file mode 100644 index 00000000..4549a1a3 --- /dev/null +++ b/docs/docs/LegacyBackupApi.md @@ -0,0 +1,827 @@ +# \LegacyBackupApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**DeleteLegacySnapshot**](LegacyBackupApi.md#DeleteLegacySnapshot) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId} | Remove One Legacy Backup Snapshot +[**GetLegacyBackupCheckpoint**](LegacyBackupApi.md#GetLegacyBackupCheckpoint) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId} | Return One Legacy Backup Checkpoint +[**GetLegacyBackupRestoreJob**](LegacyBackupApi.md#GetLegacyBackupRestoreJob) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId} | Return One Legacy Backup Restore Job +[**GetLegacySnapshot**](LegacyBackupApi.md#GetLegacySnapshot) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId} | Return One Legacy Backup Snapshot +[**GetLegacySnapshotSchedule**](LegacyBackupApi.md#GetLegacySnapshotSchedule) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule | Return One Snapshot Schedule +[**ListLegacyBackupCheckpoints**](LegacyBackupApi.md#ListLegacyBackupCheckpoints) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints | Return All Legacy Backup Checkpoints +[**ListLegacyBackupRestoreJobs**](LegacyBackupApi.md#ListLegacyBackupRestoreJobs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs | Return All Legacy Backup Restore Jobs +[**ListLegacySnapshots**](LegacyBackupApi.md#ListLegacySnapshots) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots | Return All Legacy Backup Snapshots +[**UpdateLegacySnapshotRetention**](LegacyBackupApi.md#UpdateLegacySnapshotRetention) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId} | Change One Legacy Backup Snapshot Expiration +[**UpdateLegacySnapshotSchedule**](LegacyBackupApi.md#UpdateLegacySnapshotSchedule) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule | Update Snapshot Schedule for One Cluster + + + +## DeleteLegacySnapshot + +> DeleteLegacySnapshot(ctx, groupId, clusterName, snapshotId).Execute() + +Remove One Legacy Backup Snapshot + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + + r, err := sdk.LegacyBackupApi.DeleteLegacySnapshot(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.DeleteLegacySnapshot``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLegacySnapshotRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetLegacyBackupCheckpoint + +> Checkpoint GetLegacyBackupCheckpoint(ctx, groupId, checkpointId, clusterName).Execute() + +Return One Legacy Backup Checkpoint + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + checkpointId := "checkpointId_example" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.LegacyBackupApi.GetLegacyBackupCheckpoint(context.Background(), groupId, checkpointId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.GetLegacyBackupCheckpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetLegacyBackupCheckpoint`: Checkpoint + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.GetLegacyBackupCheckpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**checkpointId** | **string** | Unique 24-hexadecimal digit string that identifies the checkpoint. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the checkpoints that you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLegacyBackupCheckpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Checkpoint**](Checkpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetLegacyBackupRestoreJob + +> RestoreJob GetLegacyBackupRestoreJob(ctx, groupId, clusterName, jobId).Execute() + +Return One Legacy Backup Restore Job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + jobId := "jobId_example" // string | + + resp, r, err := sdk.LegacyBackupApi.GetLegacyBackupRestoreJob(context.Background(), groupId, clusterName, jobId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.GetLegacyBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetLegacyBackupRestoreJob`: RestoreJob + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.GetLegacyBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster with the snapshot you want to return. | +**jobId** | **string** | Unique 24-hexadecimal digit string that identifies the restore job. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLegacyBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**RestoreJob**](RestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetLegacySnapshot + +> Snapshot GetLegacySnapshot(ctx, groupId, clusterName, snapshotId).Execute() + +Return One Legacy Backup Snapshot + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + + resp, r, err := sdk.LegacyBackupApi.GetLegacySnapshot(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.GetLegacySnapshot``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetLegacySnapshot`: Snapshot + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.GetLegacySnapshot`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLegacySnapshotRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Snapshot**](Snapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetLegacySnapshotSchedule + +> SnapshotSchedule GetLegacySnapshotSchedule(ctx, groupId, clusterName).Execute() + +Return One Snapshot Schedule + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.LegacyBackupApi.GetLegacySnapshotSchedule(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.GetLegacySnapshotSchedule``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetLegacySnapshotSchedule`: SnapshotSchedule + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.GetLegacySnapshotSchedule`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster with the snapshot you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLegacySnapshotScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**SnapshotSchedule**](SnapshotSchedule.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListLegacyBackupCheckpoints + +> PaginatedApiAtlasCheckpoint ListLegacyBackupCheckpoints(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Legacy Backup Checkpoints + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.LegacyBackupApi.ListLegacyBackupCheckpoints(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.ListLegacyBackupCheckpoints``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListLegacyBackupCheckpoints`: PaginatedApiAtlasCheckpoint + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.ListLegacyBackupCheckpoints`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the checkpoints that you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListLegacyBackupCheckpointsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiAtlasCheckpoint**](PaginatedApiAtlasCheckpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListLegacyBackupRestoreJobs + +> PaginatedRestoreJob ListLegacyBackupRestoreJobs(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).BatchId(batchId).Execute() + +Return All Legacy Backup Restore Jobs + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + batchId := "batchId_example" // string | (optional) + + resp, r, err := sdk.LegacyBackupApi.ListLegacyBackupRestoreJobs(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).BatchId(batchId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.ListLegacyBackupRestoreJobs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListLegacyBackupRestoreJobs`: PaginatedRestoreJob + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.ListLegacyBackupRestoreJobs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster with the snapshot you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListLegacyBackupRestoreJobsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **batchId** | **string** | Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch. | + +### Return type + +[**PaginatedRestoreJob**](PaginatedRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListLegacySnapshots + +> PaginatedSnapshot ListLegacySnapshots(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Completed(completed).Execute() + +Return All Legacy Backup Snapshots + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + completed := "completed_example" // string | (optional) (default to "true") + + resp, r, err := sdk.LegacyBackupApi.ListLegacySnapshots(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Completed(completed).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.ListLegacySnapshots``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListLegacySnapshots`: PaginatedSnapshot + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.ListLegacySnapshots`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListLegacySnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **completed** | **string** | Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots. | [default to "true"] + +### Return type + +[**PaginatedSnapshot**](PaginatedSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateLegacySnapshotRetention + +> Snapshot UpdateLegacySnapshotRetention(ctx, groupId, clusterName, snapshotId).Snapshot(snapshot).Execute() + +Change One Legacy Backup Snapshot Expiration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + snapshot := *openapiclient.NewSnapshot() // Snapshot | + + resp, r, err := sdk.LegacyBackupApi.UpdateLegacySnapshotRetention(context.Background(), groupId, clusterName, snapshotId).Snapshot(snapshot).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.UpdateLegacySnapshotRetention``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateLegacySnapshotRetention`: Snapshot + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.UpdateLegacySnapshotRetention`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateLegacySnapshotRetentionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **snapshot** | [**Snapshot**](Snapshot.md) | Changes One Legacy Backup Snapshot Expiration. | + +### Return type + +[**Snapshot**](Snapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateLegacySnapshotSchedule + +> SnapshotSchedule UpdateLegacySnapshotSchedule(ctx, groupId, clusterName).SnapshotSchedule(snapshotSchedule).Execute() + +Update Snapshot Schedule for One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotSchedule := *openapiclient.NewSnapshotSchedule(int(123), "32b6e34b3d91647abb20e7b8", int(123), "32b6e34b3d91647abb20e7b8", int(123), int(123), int(123), int(123), int(123)) // SnapshotSchedule | + + resp, r, err := sdk.LegacyBackupApi.UpdateLegacySnapshotSchedule(context.Background(), groupId, clusterName).SnapshotSchedule(snapshotSchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupApi.UpdateLegacySnapshotSchedule``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateLegacySnapshotSchedule`: SnapshotSchedule + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupApi.UpdateLegacySnapshotSchedule`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster with the snapshot you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateLegacySnapshotScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **snapshotSchedule** | [**SnapshotSchedule**](SnapshotSchedule.md) | Update the snapshot schedule for one cluster in the specified project. | + +### Return type + +[**SnapshotSchedule**](SnapshotSchedule.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/LegacyBackupRestoreJobsApi.md b/docs/docs/LegacyBackupRestoreJobsApi.md new file mode 100644 index 00000000..a74faa32 --- /dev/null +++ b/docs/docs/LegacyBackupRestoreJobsApi.md @@ -0,0 +1,88 @@ +# \LegacyBackupRestoreJobsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateLegacyBackupRestoreJob**](LegacyBackupRestoreJobsApi.md#CreateLegacyBackupRestoreJob) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs | Create One Legacy Backup Restore Job + + + +## CreateLegacyBackupRestoreJob + +> PaginatedRestoreJob CreateLegacyBackupRestoreJob(ctx, groupId, clusterName).RestoreJob(restoreJob).Execute() + +Create One Legacy Backup Restore Job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + restoreJob := *openapiclient.NewRestoreJob(*openapiclient.NewRestoreJobDelivery("MethodName_example")) // RestoreJob | + + resp, r, err := sdk.LegacyBackupRestoreJobsApi.CreateLegacyBackupRestoreJob(context.Background(), groupId, clusterName).RestoreJob(restoreJob).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LegacyBackupRestoreJobsApi.CreateLegacyBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateLegacyBackupRestoreJob`: PaginatedRestoreJob + fmt.Fprintf(os.Stdout, "Response from `LegacyBackupRestoreJobsApi.CreateLegacyBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster with the snapshot you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateLegacyBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **restoreJob** | [**RestoreJob**](RestoreJob.md) | Legacy backup to restore to one cluster in the specified project. | + +### Return type + +[**PaginatedRestoreJob**](PaginatedRestoreJob.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/LegacyClusterDescription.md b/docs/docs/LegacyClusterDescription.md new file mode 100644 index 00000000..923f94fa --- /dev/null +++ b/docs/docs/LegacyClusterDescription.md @@ -0,0 +1,836 @@ +# LegacyClusterDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoScaling** | Pointer to [**AutoScaling**](AutoScaling.md) | | [optional] +**BackupEnabled** | Pointer to **bool** | Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups. | [optional] +**BiConnector** | Pointer to [**BiConnector**](BiConnector.md) | | [optional] +**ClusterType** | Pointer to **string** | Configuration of nodes that comprise the cluster. | [optional] +**ConnectionStrings** | Pointer to [**ClusterDescriptionConnectionStrings**](ClusterDescriptionConnectionStrings.md) | | [optional] +**CreateDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**DiskSizeGB** | Pointer to **float64** | Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set **replicationSpecs**. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. | [optional] +**EncryptionAtRestProvider** | Pointer to **string** | Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the cluster. | [optional] [readonly] +**Labels** | Pointer to [**[]NDSLabel**](NDSLabel.md) | Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MongoDBMajorVersion** | Pointer to **string** | Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. | [optional] [default to "6.0"] +**MongoDBVersion** | Pointer to **string** | Version of MongoDB that the cluster runs. | [optional] +**MongoURI** | Pointer to **string** | Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster. | [optional] [readonly] +**MongoURIUpdated** | Pointer to **time.Time** | Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**MongoURIWithOptions** | Pointer to **string** | Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the cluster. | [optional] +**NumShards** | Pointer to **int** | Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster. | [optional] [default to 1] +**Paused** | Pointer to **bool** | Flag that indicates whether the cluster is paused. | [optional] +**PitEnabled** | Pointer to **bool** | Flag that indicates whether the cluster uses continuous cloud backups. | [optional] +**ProviderBackupEnabled** | Pointer to **bool** | Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups. | [optional] +**ProviderSettings** | Pointer to [**ClusterProviderSettings**](ClusterProviderSettings.md) | | [optional] +**ReplicationFactor** | Pointer to **int** | Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead. | [optional] [default to 3] +**ReplicationSpec** | Pointer to [**map[string]RegionSpec**](RegionSpec.md) | Physical location where MongoDB Cloud provisions cluster nodes. | [optional] +**ReplicationSpecs** | Pointer to [**[]LegacyReplicationSpec**](LegacyReplicationSpec.md) | List of settings that configure your cluster regions. - For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes. - For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes. | [optional] +**RootCertType** | Pointer to **string** | Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group. | [optional] [default to "ISRGROOTX1"] +**SrvAddress** | Pointer to **string** | Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options. | [optional] [readonly] +**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of the cluster. | [optional] [readonly] +**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. | [optional] [default to false] +**VersionReleaseSystem** | Pointer to **string** | Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**. | [optional] [default to "LTS"] + +## Methods + +### NewLegacyClusterDescription + +`func NewLegacyClusterDescription() *LegacyClusterDescription` + +NewLegacyClusterDescription instantiates a new LegacyClusterDescription object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLegacyClusterDescriptionWithDefaults + +`func NewLegacyClusterDescriptionWithDefaults() *LegacyClusterDescription` + +NewLegacyClusterDescriptionWithDefaults instantiates a new LegacyClusterDescription object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutoScaling + +`func (o *LegacyClusterDescription) GetAutoScaling() AutoScaling` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *LegacyClusterDescription) GetAutoScalingOk() (*AutoScaling, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *LegacyClusterDescription) SetAutoScaling(v AutoScaling)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *LegacyClusterDescription) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetBackupEnabled + +`func (o *LegacyClusterDescription) GetBackupEnabled() bool` + +GetBackupEnabled returns the BackupEnabled field if non-nil, zero value otherwise. + +### GetBackupEnabledOk + +`func (o *LegacyClusterDescription) GetBackupEnabledOk() (*bool, bool)` + +GetBackupEnabledOk returns a tuple with the BackupEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupEnabled + +`func (o *LegacyClusterDescription) SetBackupEnabled(v bool)` + +SetBackupEnabled sets BackupEnabled field to given value. + +### HasBackupEnabled + +`func (o *LegacyClusterDescription) HasBackupEnabled() bool` + +HasBackupEnabled returns a boolean if a field has been set. + +### GetBiConnector + +`func (o *LegacyClusterDescription) GetBiConnector() BiConnector` + +GetBiConnector returns the BiConnector field if non-nil, zero value otherwise. + +### GetBiConnectorOk + +`func (o *LegacyClusterDescription) GetBiConnectorOk() (*BiConnector, bool)` + +GetBiConnectorOk returns a tuple with the BiConnector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBiConnector + +`func (o *LegacyClusterDescription) SetBiConnector(v BiConnector)` + +SetBiConnector sets BiConnector field to given value. + +### HasBiConnector + +`func (o *LegacyClusterDescription) HasBiConnector() bool` + +HasBiConnector returns a boolean if a field has been set. + +### GetClusterType + +`func (o *LegacyClusterDescription) GetClusterType() string` + +GetClusterType returns the ClusterType field if non-nil, zero value otherwise. + +### GetClusterTypeOk + +`func (o *LegacyClusterDescription) GetClusterTypeOk() (*string, bool)` + +GetClusterTypeOk returns a tuple with the ClusterType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterType + +`func (o *LegacyClusterDescription) SetClusterType(v string)` + +SetClusterType sets ClusterType field to given value. + +### HasClusterType + +`func (o *LegacyClusterDescription) HasClusterType() bool` + +HasClusterType returns a boolean if a field has been set. + +### GetConnectionStrings + +`func (o *LegacyClusterDescription) GetConnectionStrings() ClusterDescriptionConnectionStrings` + +GetConnectionStrings returns the ConnectionStrings field if non-nil, zero value otherwise. + +### GetConnectionStringsOk + +`func (o *LegacyClusterDescription) GetConnectionStringsOk() (*ClusterDescriptionConnectionStrings, bool)` + +GetConnectionStringsOk returns a tuple with the ConnectionStrings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionStrings + +`func (o *LegacyClusterDescription) SetConnectionStrings(v ClusterDescriptionConnectionStrings)` + +SetConnectionStrings sets ConnectionStrings field to given value. + +### HasConnectionStrings + +`func (o *LegacyClusterDescription) HasConnectionStrings() bool` + +HasConnectionStrings returns a boolean if a field has been set. + +### GetCreateDate + +`func (o *LegacyClusterDescription) GetCreateDate() time.Time` + +GetCreateDate returns the CreateDate field if non-nil, zero value otherwise. + +### GetCreateDateOk + +`func (o *LegacyClusterDescription) GetCreateDateOk() (*time.Time, bool)` + +GetCreateDateOk returns a tuple with the CreateDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreateDate + +`func (o *LegacyClusterDescription) SetCreateDate(v time.Time)` + +SetCreateDate sets CreateDate field to given value. + +### HasCreateDate + +`func (o *LegacyClusterDescription) HasCreateDate() bool` + +HasCreateDate returns a boolean if a field has been set. + +### GetDiskSizeGB + +`func (o *LegacyClusterDescription) GetDiskSizeGB() float64` + +GetDiskSizeGB returns the DiskSizeGB field if non-nil, zero value otherwise. + +### GetDiskSizeGBOk + +`func (o *LegacyClusterDescription) GetDiskSizeGBOk() (*float64, bool)` + +GetDiskSizeGBOk returns a tuple with the DiskSizeGB field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiskSizeGB + +`func (o *LegacyClusterDescription) SetDiskSizeGB(v float64)` + +SetDiskSizeGB sets DiskSizeGB field to given value. + +### HasDiskSizeGB + +`func (o *LegacyClusterDescription) HasDiskSizeGB() bool` + +HasDiskSizeGB returns a boolean if a field has been set. + +### GetEncryptionAtRestProvider + +`func (o *LegacyClusterDescription) GetEncryptionAtRestProvider() string` + +GetEncryptionAtRestProvider returns the EncryptionAtRestProvider field if non-nil, zero value otherwise. + +### GetEncryptionAtRestProviderOk + +`func (o *LegacyClusterDescription) GetEncryptionAtRestProviderOk() (*string, bool)` + +GetEncryptionAtRestProviderOk returns a tuple with the EncryptionAtRestProvider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionAtRestProvider + +`func (o *LegacyClusterDescription) SetEncryptionAtRestProvider(v string)` + +SetEncryptionAtRestProvider sets EncryptionAtRestProvider field to given value. + +### HasEncryptionAtRestProvider + +`func (o *LegacyClusterDescription) HasEncryptionAtRestProvider() bool` + +HasEncryptionAtRestProvider returns a boolean if a field has been set. + +### GetGroupId + +`func (o *LegacyClusterDescription) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *LegacyClusterDescription) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *LegacyClusterDescription) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *LegacyClusterDescription) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *LegacyClusterDescription) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LegacyClusterDescription) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LegacyClusterDescription) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LegacyClusterDescription) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLabels + +`func (o *LegacyClusterDescription) GetLabels() []NDSLabel` + +GetLabels returns the Labels field if non-nil, zero value otherwise. + +### GetLabelsOk + +`func (o *LegacyClusterDescription) GetLabelsOk() (*[]NDSLabel, bool)` + +GetLabelsOk returns a tuple with the Labels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabels + +`func (o *LegacyClusterDescription) SetLabels(v []NDSLabel)` + +SetLabels sets Labels field to given value. + +### HasLabels + +`func (o *LegacyClusterDescription) HasLabels() bool` + +HasLabels returns a boolean if a field has been set. + +### GetLinks + +`func (o *LegacyClusterDescription) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *LegacyClusterDescription) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *LegacyClusterDescription) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *LegacyClusterDescription) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMongoDBMajorVersion + +`func (o *LegacyClusterDescription) GetMongoDBMajorVersion() string` + +GetMongoDBMajorVersion returns the MongoDBMajorVersion field if non-nil, zero value otherwise. + +### GetMongoDBMajorVersionOk + +`func (o *LegacyClusterDescription) GetMongoDBMajorVersionOk() (*string, bool)` + +GetMongoDBMajorVersionOk returns a tuple with the MongoDBMajorVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoDBMajorVersion + +`func (o *LegacyClusterDescription) SetMongoDBMajorVersion(v string)` + +SetMongoDBMajorVersion sets MongoDBMajorVersion field to given value. + +### HasMongoDBMajorVersion + +`func (o *LegacyClusterDescription) HasMongoDBMajorVersion() bool` + +HasMongoDBMajorVersion returns a boolean if a field has been set. + +### GetMongoDBVersion + +`func (o *LegacyClusterDescription) GetMongoDBVersion() string` + +GetMongoDBVersion returns the MongoDBVersion field if non-nil, zero value otherwise. + +### GetMongoDBVersionOk + +`func (o *LegacyClusterDescription) GetMongoDBVersionOk() (*string, bool)` + +GetMongoDBVersionOk returns a tuple with the MongoDBVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoDBVersion + +`func (o *LegacyClusterDescription) SetMongoDBVersion(v string)` + +SetMongoDBVersion sets MongoDBVersion field to given value. + +### HasMongoDBVersion + +`func (o *LegacyClusterDescription) HasMongoDBVersion() bool` + +HasMongoDBVersion returns a boolean if a field has been set. + +### GetMongoURI + +`func (o *LegacyClusterDescription) GetMongoURI() string` + +GetMongoURI returns the MongoURI field if non-nil, zero value otherwise. + +### GetMongoURIOk + +`func (o *LegacyClusterDescription) GetMongoURIOk() (*string, bool)` + +GetMongoURIOk returns a tuple with the MongoURI field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoURI + +`func (o *LegacyClusterDescription) SetMongoURI(v string)` + +SetMongoURI sets MongoURI field to given value. + +### HasMongoURI + +`func (o *LegacyClusterDescription) HasMongoURI() bool` + +HasMongoURI returns a boolean if a field has been set. + +### GetMongoURIUpdated + +`func (o *LegacyClusterDescription) GetMongoURIUpdated() time.Time` + +GetMongoURIUpdated returns the MongoURIUpdated field if non-nil, zero value otherwise. + +### GetMongoURIUpdatedOk + +`func (o *LegacyClusterDescription) GetMongoURIUpdatedOk() (*time.Time, bool)` + +GetMongoURIUpdatedOk returns a tuple with the MongoURIUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoURIUpdated + +`func (o *LegacyClusterDescription) SetMongoURIUpdated(v time.Time)` + +SetMongoURIUpdated sets MongoURIUpdated field to given value. + +### HasMongoURIUpdated + +`func (o *LegacyClusterDescription) HasMongoURIUpdated() bool` + +HasMongoURIUpdated returns a boolean if a field has been set. + +### GetMongoURIWithOptions + +`func (o *LegacyClusterDescription) GetMongoURIWithOptions() string` + +GetMongoURIWithOptions returns the MongoURIWithOptions field if non-nil, zero value otherwise. + +### GetMongoURIWithOptionsOk + +`func (o *LegacyClusterDescription) GetMongoURIWithOptionsOk() (*string, bool)` + +GetMongoURIWithOptionsOk returns a tuple with the MongoURIWithOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoURIWithOptions + +`func (o *LegacyClusterDescription) SetMongoURIWithOptions(v string)` + +SetMongoURIWithOptions sets MongoURIWithOptions field to given value. + +### HasMongoURIWithOptions + +`func (o *LegacyClusterDescription) HasMongoURIWithOptions() bool` + +HasMongoURIWithOptions returns a boolean if a field has been set. + +### GetName + +`func (o *LegacyClusterDescription) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LegacyClusterDescription) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LegacyClusterDescription) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LegacyClusterDescription) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetNumShards + +`func (o *LegacyClusterDescription) GetNumShards() int` + +GetNumShards returns the NumShards field if non-nil, zero value otherwise. + +### GetNumShardsOk + +`func (o *LegacyClusterDescription) GetNumShardsOk() (*int, bool)` + +GetNumShardsOk returns a tuple with the NumShards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumShards + +`func (o *LegacyClusterDescription) SetNumShards(v int)` + +SetNumShards sets NumShards field to given value. + +### HasNumShards + +`func (o *LegacyClusterDescription) HasNumShards() bool` + +HasNumShards returns a boolean if a field has been set. + +### GetPaused + +`func (o *LegacyClusterDescription) GetPaused() bool` + +GetPaused returns the Paused field if non-nil, zero value otherwise. + +### GetPausedOk + +`func (o *LegacyClusterDescription) GetPausedOk() (*bool, bool)` + +GetPausedOk returns a tuple with the Paused field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPaused + +`func (o *LegacyClusterDescription) SetPaused(v bool)` + +SetPaused sets Paused field to given value. + +### HasPaused + +`func (o *LegacyClusterDescription) HasPaused() bool` + +HasPaused returns a boolean if a field has been set. + +### GetPitEnabled + +`func (o *LegacyClusterDescription) GetPitEnabled() bool` + +GetPitEnabled returns the PitEnabled field if non-nil, zero value otherwise. + +### GetPitEnabledOk + +`func (o *LegacyClusterDescription) GetPitEnabledOk() (*bool, bool)` + +GetPitEnabledOk returns a tuple with the PitEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPitEnabled + +`func (o *LegacyClusterDescription) SetPitEnabled(v bool)` + +SetPitEnabled sets PitEnabled field to given value. + +### HasPitEnabled + +`func (o *LegacyClusterDescription) HasPitEnabled() bool` + +HasPitEnabled returns a boolean if a field has been set. + +### GetProviderBackupEnabled + +`func (o *LegacyClusterDescription) GetProviderBackupEnabled() bool` + +GetProviderBackupEnabled returns the ProviderBackupEnabled field if non-nil, zero value otherwise. + +### GetProviderBackupEnabledOk + +`func (o *LegacyClusterDescription) GetProviderBackupEnabledOk() (*bool, bool)` + +GetProviderBackupEnabledOk returns a tuple with the ProviderBackupEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderBackupEnabled + +`func (o *LegacyClusterDescription) SetProviderBackupEnabled(v bool)` + +SetProviderBackupEnabled sets ProviderBackupEnabled field to given value. + +### HasProviderBackupEnabled + +`func (o *LegacyClusterDescription) HasProviderBackupEnabled() bool` + +HasProviderBackupEnabled returns a boolean if a field has been set. + +### GetProviderSettings + +`func (o *LegacyClusterDescription) GetProviderSettings() ClusterProviderSettings` + +GetProviderSettings returns the ProviderSettings field if non-nil, zero value otherwise. + +### GetProviderSettingsOk + +`func (o *LegacyClusterDescription) GetProviderSettingsOk() (*ClusterProviderSettings, bool)` + +GetProviderSettingsOk returns a tuple with the ProviderSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderSettings + +`func (o *LegacyClusterDescription) SetProviderSettings(v ClusterProviderSettings)` + +SetProviderSettings sets ProviderSettings field to given value. + +### HasProviderSettings + +`func (o *LegacyClusterDescription) HasProviderSettings() bool` + +HasProviderSettings returns a boolean if a field has been set. + +### GetReplicationFactor + +`func (o *LegacyClusterDescription) GetReplicationFactor() int` + +GetReplicationFactor returns the ReplicationFactor field if non-nil, zero value otherwise. + +### GetReplicationFactorOk + +`func (o *LegacyClusterDescription) GetReplicationFactorOk() (*int, bool)` + +GetReplicationFactorOk returns a tuple with the ReplicationFactor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicationFactor + +`func (o *LegacyClusterDescription) SetReplicationFactor(v int)` + +SetReplicationFactor sets ReplicationFactor field to given value. + +### HasReplicationFactor + +`func (o *LegacyClusterDescription) HasReplicationFactor() bool` + +HasReplicationFactor returns a boolean if a field has been set. + +### GetReplicationSpec + +`func (o *LegacyClusterDescription) GetReplicationSpec() map[string]RegionSpec` + +GetReplicationSpec returns the ReplicationSpec field if non-nil, zero value otherwise. + +### GetReplicationSpecOk + +`func (o *LegacyClusterDescription) GetReplicationSpecOk() (*map[string]RegionSpec, bool)` + +GetReplicationSpecOk returns a tuple with the ReplicationSpec field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicationSpec + +`func (o *LegacyClusterDescription) SetReplicationSpec(v map[string]RegionSpec)` + +SetReplicationSpec sets ReplicationSpec field to given value. + +### HasReplicationSpec + +`func (o *LegacyClusterDescription) HasReplicationSpec() bool` + +HasReplicationSpec returns a boolean if a field has been set. + +### GetReplicationSpecs + +`func (o *LegacyClusterDescription) GetReplicationSpecs() []LegacyReplicationSpec` + +GetReplicationSpecs returns the ReplicationSpecs field if non-nil, zero value otherwise. + +### GetReplicationSpecsOk + +`func (o *LegacyClusterDescription) GetReplicationSpecsOk() (*[]LegacyReplicationSpec, bool)` + +GetReplicationSpecsOk returns a tuple with the ReplicationSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicationSpecs + +`func (o *LegacyClusterDescription) SetReplicationSpecs(v []LegacyReplicationSpec)` + +SetReplicationSpecs sets ReplicationSpecs field to given value. + +### HasReplicationSpecs + +`func (o *LegacyClusterDescription) HasReplicationSpecs() bool` + +HasReplicationSpecs returns a boolean if a field has been set. + +### GetRootCertType + +`func (o *LegacyClusterDescription) GetRootCertType() string` + +GetRootCertType returns the RootCertType field if non-nil, zero value otherwise. + +### GetRootCertTypeOk + +`func (o *LegacyClusterDescription) GetRootCertTypeOk() (*string, bool)` + +GetRootCertTypeOk returns a tuple with the RootCertType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootCertType + +`func (o *LegacyClusterDescription) SetRootCertType(v string)` + +SetRootCertType sets RootCertType field to given value. + +### HasRootCertType + +`func (o *LegacyClusterDescription) HasRootCertType() bool` + +HasRootCertType returns a boolean if a field has been set. + +### GetSrvAddress + +`func (o *LegacyClusterDescription) GetSrvAddress() string` + +GetSrvAddress returns the SrvAddress field if non-nil, zero value otherwise. + +### GetSrvAddressOk + +`func (o *LegacyClusterDescription) GetSrvAddressOk() (*string, bool)` + +GetSrvAddressOk returns a tuple with the SrvAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSrvAddress + +`func (o *LegacyClusterDescription) SetSrvAddress(v string)` + +SetSrvAddress sets SrvAddress field to given value. + +### HasSrvAddress + +`func (o *LegacyClusterDescription) HasSrvAddress() bool` + +HasSrvAddress returns a boolean if a field has been set. + +### GetStateName + +`func (o *LegacyClusterDescription) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *LegacyClusterDescription) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *LegacyClusterDescription) SetStateName(v string)` + +SetStateName sets StateName field to given value. + +### HasStateName + +`func (o *LegacyClusterDescription) HasStateName() bool` + +HasStateName returns a boolean if a field has been set. + +### GetTerminationProtectionEnabled + +`func (o *LegacyClusterDescription) GetTerminationProtectionEnabled() bool` + +GetTerminationProtectionEnabled returns the TerminationProtectionEnabled field if non-nil, zero value otherwise. + +### GetTerminationProtectionEnabledOk + +`func (o *LegacyClusterDescription) GetTerminationProtectionEnabledOk() (*bool, bool)` + +GetTerminationProtectionEnabledOk returns a tuple with the TerminationProtectionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerminationProtectionEnabled + +`func (o *LegacyClusterDescription) SetTerminationProtectionEnabled(v bool)` + +SetTerminationProtectionEnabled sets TerminationProtectionEnabled field to given value. + +### HasTerminationProtectionEnabled + +`func (o *LegacyClusterDescription) HasTerminationProtectionEnabled() bool` + +HasTerminationProtectionEnabled returns a boolean if a field has been set. + +### GetVersionReleaseSystem + +`func (o *LegacyClusterDescription) GetVersionReleaseSystem() string` + +GetVersionReleaseSystem returns the VersionReleaseSystem field if non-nil, zero value otherwise. + +### GetVersionReleaseSystemOk + +`func (o *LegacyClusterDescription) GetVersionReleaseSystemOk() (*string, bool)` + +GetVersionReleaseSystemOk returns a tuple with the VersionReleaseSystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionReleaseSystem + +`func (o *LegacyClusterDescription) SetVersionReleaseSystem(v string)` + +SetVersionReleaseSystem sets VersionReleaseSystem field to given value. + +### HasVersionReleaseSystem + +`func (o *LegacyClusterDescription) HasVersionReleaseSystem() bool` + +HasVersionReleaseSystem returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LegacyReplicationSpec.md b/docs/docs/LegacyReplicationSpec.md new file mode 100644 index 00000000..c2bc787b --- /dev/null +++ b/docs/docs/LegacyReplicationSpec.md @@ -0,0 +1,134 @@ +# LegacyReplicationSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster. - If you include existing zones in the request, you must specify this parameter. - If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request. | [optional] +**NumShards** | Pointer to **int** | Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations. | [optional] [default to 1] +**RegionsConfig** | Pointer to [**map[string]RegionSpec**](RegionSpec.md) | Physical location where MongoDB Cloud provisions cluster nodes. | [optional] +**ZoneName** | Pointer to **string** | Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`. | [optional] + +## Methods + +### NewLegacyReplicationSpec + +`func NewLegacyReplicationSpec() *LegacyReplicationSpec` + +NewLegacyReplicationSpec instantiates a new LegacyReplicationSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLegacyReplicationSpecWithDefaults + +`func NewLegacyReplicationSpecWithDefaults() *LegacyReplicationSpec` + +NewLegacyReplicationSpecWithDefaults instantiates a new LegacyReplicationSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *LegacyReplicationSpec) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LegacyReplicationSpec) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LegacyReplicationSpec) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LegacyReplicationSpec) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNumShards + +`func (o *LegacyReplicationSpec) GetNumShards() int` + +GetNumShards returns the NumShards field if non-nil, zero value otherwise. + +### GetNumShardsOk + +`func (o *LegacyReplicationSpec) GetNumShardsOk() (*int, bool)` + +GetNumShardsOk returns a tuple with the NumShards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumShards + +`func (o *LegacyReplicationSpec) SetNumShards(v int)` + +SetNumShards sets NumShards field to given value. + +### HasNumShards + +`func (o *LegacyReplicationSpec) HasNumShards() bool` + +HasNumShards returns a boolean if a field has been set. + +### GetRegionsConfig + +`func (o *LegacyReplicationSpec) GetRegionsConfig() map[string]RegionSpec` + +GetRegionsConfig returns the RegionsConfig field if non-nil, zero value otherwise. + +### GetRegionsConfigOk + +`func (o *LegacyReplicationSpec) GetRegionsConfigOk() (*map[string]RegionSpec, bool)` + +GetRegionsConfigOk returns a tuple with the RegionsConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionsConfig + +`func (o *LegacyReplicationSpec) SetRegionsConfig(v map[string]RegionSpec)` + +SetRegionsConfig sets RegionsConfig field to given value. + +### HasRegionsConfig + +`func (o *LegacyReplicationSpec) HasRegionsConfig() bool` + +HasRegionsConfig returns a boolean if a field has been set. + +### GetZoneName + +`func (o *LegacyReplicationSpec) GetZoneName() string` + +GetZoneName returns the ZoneName field if non-nil, zero value otherwise. + +### GetZoneNameOk + +`func (o *LegacyReplicationSpec) GetZoneNameOk() (*string, bool)` + +GetZoneNameOk returns a tuple with the ZoneName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetZoneName + +`func (o *LegacyReplicationSpec) SetZoneName(v string)` + +SetZoneName sets ZoneName field to given value. + +### HasZoneName + +`func (o *LegacyReplicationSpec) HasZoneName() bool` + +HasZoneName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LessThanDaysThreshold.md b/docs/docs/LessThanDaysThreshold.md new file mode 100644 index 00000000..39ebf4a4 --- /dev/null +++ b/docs/docs/LessThanDaysThreshold.md @@ -0,0 +1,108 @@ +# LessThanDaysThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value. | [optional] +**Threshold** | Pointer to **int** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to **string** | Element used to express the quantity. This can be an element of time, storage capacity, and the like. | [optional] + +## Methods + +### NewLessThanDaysThreshold + +`func NewLessThanDaysThreshold() *LessThanDaysThreshold` + +NewLessThanDaysThreshold instantiates a new LessThanDaysThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLessThanDaysThresholdWithDefaults + +`func NewLessThanDaysThresholdWithDefaults() *LessThanDaysThreshold` + +NewLessThanDaysThresholdWithDefaults instantiates a new LessThanDaysThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOperator + +`func (o *LessThanDaysThreshold) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *LessThanDaysThreshold) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *LessThanDaysThreshold) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *LessThanDaysThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *LessThanDaysThreshold) GetThreshold() int` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *LessThanDaysThreshold) GetThresholdOk() (*int, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *LessThanDaysThreshold) SetThreshold(v int)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *LessThanDaysThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *LessThanDaysThreshold) GetUnits() string` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *LessThanDaysThreshold) GetUnitsOk() (*string, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *LessThanDaysThreshold) SetUnits(v string)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *LessThanDaysThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LessThanTimeThreshold.md b/docs/docs/LessThanTimeThreshold.md new file mode 100644 index 00000000..9b1eb5d5 --- /dev/null +++ b/docs/docs/LessThanTimeThreshold.md @@ -0,0 +1,108 @@ +# LessThanTimeThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value. | [optional] +**Threshold** | Pointer to **int** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**TimeMetricUnits**](TimeMetricUnits.md) | | [optional] [default to TIMEMETRICUNITS_HOURS] + +## Methods + +### NewLessThanTimeThreshold + +`func NewLessThanTimeThreshold() *LessThanTimeThreshold` + +NewLessThanTimeThreshold instantiates a new LessThanTimeThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLessThanTimeThresholdWithDefaults + +`func NewLessThanTimeThresholdWithDefaults() *LessThanTimeThreshold` + +NewLessThanTimeThresholdWithDefaults instantiates a new LessThanTimeThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOperator + +`func (o *LessThanTimeThreshold) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *LessThanTimeThreshold) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *LessThanTimeThreshold) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *LessThanTimeThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *LessThanTimeThreshold) GetThreshold() int` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *LessThanTimeThreshold) GetThresholdOk() (*int, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *LessThanTimeThreshold) SetThreshold(v int)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *LessThanTimeThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *LessThanTimeThreshold) GetUnits() TimeMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *LessThanTimeThreshold) GetUnitsOk() (*TimeMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *LessThanTimeThreshold) SetUnits(v TimeMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *LessThanTimeThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LessThanTimeThresholdAlertConfigViewForNdsGroup.md b/docs/docs/LessThanTimeThresholdAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..02b17caf --- /dev/null +++ b/docs/docs/LessThanTimeThresholdAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# LessThanTimeThresholdAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold**](ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]ReplicaSetMatcher**](ReplicaSetMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**LessThanTimeThreshold**](LessThanTimeThreshold.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewLessThanTimeThresholdAlertConfigViewForNdsGroup + +`func NewLessThanTimeThresholdAlertConfigViewForNdsGroup(eventTypeName ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold, ) *LessThanTimeThresholdAlertConfigViewForNdsGroup` + +NewLessThanTimeThresholdAlertConfigViewForNdsGroup instantiates a new LessThanTimeThresholdAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLessThanTimeThresholdAlertConfigViewForNdsGroupWithDefaults + +`func NewLessThanTimeThresholdAlertConfigViewForNdsGroupWithDefaults() *LessThanTimeThresholdAlertConfigViewForNdsGroup` + +NewLessThanTimeThresholdAlertConfigViewForNdsGroupWithDefaults instantiates a new LessThanTimeThresholdAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetEventTypeName() ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetEventTypeName(v ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetMatchers() []ReplicaSetMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetMatchersOk() (*[]ReplicaSetMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetMatchers(v []ReplicaSetMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetThreshold() LessThanTimeThreshold` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetThresholdOk() (*LessThanTimeThreshold, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetThreshold(v LessThanTimeThreshold)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *LessThanTimeThresholdAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Limit.md b/docs/docs/Limit.md new file mode 100644 index 00000000..4c42b27f --- /dev/null +++ b/docs/docs/Limit.md @@ -0,0 +1,202 @@ +# Limit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CurrentUsage** | Pointer to **int64** | Amount that indicates the current usage of the limit. | [optional] [readonly] +**DefaultLimit** | Pointer to **int64** | Default value of the limit. | [optional] [readonly] +**MaximumLimit** | Pointer to **int64** | Maximum value of the limit. | [optional] [readonly] +**Name** | **string** | Human-readable label that identifies the user-managed limit to modify. | [readonly] +**Value** | **int64** | Amount to set the limit to. | +**LastModifiedDate** | Pointer to **time.Time** | Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**OverrunPolicy** | Pointer to **string** | Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit. | [optional] + +## Methods + +### NewLimit + +`func NewLimit(name string, value int64, ) *Limit` + +NewLimit instantiates a new Limit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLimitWithDefaults + +`func NewLimitWithDefaults() *Limit` + +NewLimitWithDefaults instantiates a new Limit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCurrentUsage + +`func (o *Limit) GetCurrentUsage() int64` + +GetCurrentUsage returns the CurrentUsage field if non-nil, zero value otherwise. + +### GetCurrentUsageOk + +`func (o *Limit) GetCurrentUsageOk() (*int64, bool)` + +GetCurrentUsageOk returns a tuple with the CurrentUsage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentUsage + +`func (o *Limit) SetCurrentUsage(v int64)` + +SetCurrentUsage sets CurrentUsage field to given value. + +### HasCurrentUsage + +`func (o *Limit) HasCurrentUsage() bool` + +HasCurrentUsage returns a boolean if a field has been set. + +### GetDefaultLimit + +`func (o *Limit) GetDefaultLimit() int64` + +GetDefaultLimit returns the DefaultLimit field if non-nil, zero value otherwise. + +### GetDefaultLimitOk + +`func (o *Limit) GetDefaultLimitOk() (*int64, bool)` + +GetDefaultLimitOk returns a tuple with the DefaultLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultLimit + +`func (o *Limit) SetDefaultLimit(v int64)` + +SetDefaultLimit sets DefaultLimit field to given value. + +### HasDefaultLimit + +`func (o *Limit) HasDefaultLimit() bool` + +HasDefaultLimit returns a boolean if a field has been set. + +### GetMaximumLimit + +`func (o *Limit) GetMaximumLimit() int64` + +GetMaximumLimit returns the MaximumLimit field if non-nil, zero value otherwise. + +### GetMaximumLimitOk + +`func (o *Limit) GetMaximumLimitOk() (*int64, bool)` + +GetMaximumLimitOk returns a tuple with the MaximumLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaximumLimit + +`func (o *Limit) SetMaximumLimit(v int64)` + +SetMaximumLimit sets MaximumLimit field to given value. + +### HasMaximumLimit + +`func (o *Limit) HasMaximumLimit() bool` + +HasMaximumLimit returns a boolean if a field has been set. + +### GetName + +`func (o *Limit) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Limit) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Limit) SetName(v string)` + +SetName sets Name field to given value. + + +### GetValue + +`func (o *Limit) GetValue() int64` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Limit) GetValueOk() (*int64, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Limit) SetValue(v int64)` + +SetValue sets Value field to given value. + + +### GetLastModifiedDate + +`func (o *Limit) GetLastModifiedDate() time.Time` + +GetLastModifiedDate returns the LastModifiedDate field if non-nil, zero value otherwise. + +### GetLastModifiedDateOk + +`func (o *Limit) GetLastModifiedDateOk() (*time.Time, bool)` + +GetLastModifiedDateOk returns a tuple with the LastModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastModifiedDate + +`func (o *Limit) SetLastModifiedDate(v time.Time)` + +SetLastModifiedDate sets LastModifiedDate field to given value. + +### HasLastModifiedDate + +`func (o *Limit) HasLastModifiedDate() bool` + +HasLastModifiedDate returns a boolean if a field has been set. + +### GetOverrunPolicy + +`func (o *Limit) GetOverrunPolicy() string` + +GetOverrunPolicy returns the OverrunPolicy field if non-nil, zero value otherwise. + +### GetOverrunPolicyOk + +`func (o *Limit) GetOverrunPolicyOk() (*string, bool)` + +GetOverrunPolicyOk returns a tuple with the OverrunPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOverrunPolicy + +`func (o *Limit) SetOverrunPolicy(v string)` + +SetOverrunPolicy sets OverrunPolicy field to given value. + +### HasOverrunPolicy + +`func (o *Limit) HasOverrunPolicy() bool` + +HasOverrunPolicy returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LineItem.md b/docs/docs/LineItem.md new file mode 100644 index 00000000..d2535238 --- /dev/null +++ b/docs/docs/LineItem.md @@ -0,0 +1,472 @@ +# LineItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster that incurred the charge. | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**DiscountCents** | Pointer to **int64** | Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies. | [optional] [readonly] +**EndDate** | Pointer to **time.Time** | Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project associated to this line item. | [optional] [readonly] +**GroupName** | Pointer to **string** | Human-readable label that identifies the project. | [optional] +**Note** | Pointer to **string** | Comment that applies to this line item. | [optional] [readonly] +**PercentDiscount** | Pointer to **float32** | Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies. | [optional] [readonly] +**Quantity** | Pointer to **float64** | Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units. | [optional] [readonly] +**Sku** | Pointer to **string** | Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service. | [optional] [readonly] +**StartDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**StitchAppName** | Pointer to **string** | Human-readable label that identifies the Atlas App Services application associated with this line item. | [optional] [readonly] +**TierLowerBound** | Pointer to **float64** | Lower bound for usage amount range in current SKU tier. **NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered. | [optional] [readonly] +**TierUpperBound** | Pointer to **float64** | Upper bound for usage amount range in current SKU tier. **NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered. | [optional] [readonly] +**TotalPriceCents** | Pointer to **int64** | Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100. | [optional] [readonly] +**Unit** | Pointer to **string** | Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like. | [optional] [readonly] +**UnitPriceDollars** | Pointer to **float64** | Value per **unit** for this line item expressed in US Dollars. | [optional] [readonly] + +## Methods + +### NewLineItem + +`func NewLineItem() *LineItem` + +NewLineItem instantiates a new LineItem object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLineItemWithDefaults + +`func NewLineItemWithDefaults() *LineItem` + +NewLineItemWithDefaults instantiates a new LineItem object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *LineItem) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *LineItem) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *LineItem) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *LineItem) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *LineItem) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LineItem) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LineItem) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LineItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetDiscountCents + +`func (o *LineItem) GetDiscountCents() int64` + +GetDiscountCents returns the DiscountCents field if non-nil, zero value otherwise. + +### GetDiscountCentsOk + +`func (o *LineItem) GetDiscountCentsOk() (*int64, bool)` + +GetDiscountCentsOk returns a tuple with the DiscountCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscountCents + +`func (o *LineItem) SetDiscountCents(v int64)` + +SetDiscountCents sets DiscountCents field to given value. + +### HasDiscountCents + +`func (o *LineItem) HasDiscountCents() bool` + +HasDiscountCents returns a boolean if a field has been set. + +### GetEndDate + +`func (o *LineItem) GetEndDate() time.Time` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *LineItem) GetEndDateOk() (*time.Time, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *LineItem) SetEndDate(v time.Time)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *LineItem) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetGroupId + +`func (o *LineItem) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *LineItem) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *LineItem) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *LineItem) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetGroupName + +`func (o *LineItem) GetGroupName() string` + +GetGroupName returns the GroupName field if non-nil, zero value otherwise. + +### GetGroupNameOk + +`func (o *LineItem) GetGroupNameOk() (*string, bool)` + +GetGroupNameOk returns a tuple with the GroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupName + +`func (o *LineItem) SetGroupName(v string)` + +SetGroupName sets GroupName field to given value. + +### HasGroupName + +`func (o *LineItem) HasGroupName() bool` + +HasGroupName returns a boolean if a field has been set. + +### GetNote + +`func (o *LineItem) GetNote() string` + +GetNote returns the Note field if non-nil, zero value otherwise. + +### GetNoteOk + +`func (o *LineItem) GetNoteOk() (*string, bool)` + +GetNoteOk returns a tuple with the Note field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNote + +`func (o *LineItem) SetNote(v string)` + +SetNote sets Note field to given value. + +### HasNote + +`func (o *LineItem) HasNote() bool` + +HasNote returns a boolean if a field has been set. + +### GetPercentDiscount + +`func (o *LineItem) GetPercentDiscount() float32` + +GetPercentDiscount returns the PercentDiscount field if non-nil, zero value otherwise. + +### GetPercentDiscountOk + +`func (o *LineItem) GetPercentDiscountOk() (*float32, bool)` + +GetPercentDiscountOk returns a tuple with the PercentDiscount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPercentDiscount + +`func (o *LineItem) SetPercentDiscount(v float32)` + +SetPercentDiscount sets PercentDiscount field to given value. + +### HasPercentDiscount + +`func (o *LineItem) HasPercentDiscount() bool` + +HasPercentDiscount returns a boolean if a field has been set. + +### GetQuantity + +`func (o *LineItem) GetQuantity() float64` + +GetQuantity returns the Quantity field if non-nil, zero value otherwise. + +### GetQuantityOk + +`func (o *LineItem) GetQuantityOk() (*float64, bool)` + +GetQuantityOk returns a tuple with the Quantity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuantity + +`func (o *LineItem) SetQuantity(v float64)` + +SetQuantity sets Quantity field to given value. + +### HasQuantity + +`func (o *LineItem) HasQuantity() bool` + +HasQuantity returns a boolean if a field has been set. + +### GetSku + +`func (o *LineItem) GetSku() string` + +GetSku returns the Sku field if non-nil, zero value otherwise. + +### GetSkuOk + +`func (o *LineItem) GetSkuOk() (*string, bool)` + +GetSkuOk returns a tuple with the Sku field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSku + +`func (o *LineItem) SetSku(v string)` + +SetSku sets Sku field to given value. + +### HasSku + +`func (o *LineItem) HasSku() bool` + +HasSku returns a boolean if a field has been set. + +### GetStartDate + +`func (o *LineItem) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *LineItem) GetStartDateOk() (*time.Time, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *LineItem) SetStartDate(v time.Time)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *LineItem) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetStitchAppName + +`func (o *LineItem) GetStitchAppName() string` + +GetStitchAppName returns the StitchAppName field if non-nil, zero value otherwise. + +### GetStitchAppNameOk + +`func (o *LineItem) GetStitchAppNameOk() (*string, bool)` + +GetStitchAppNameOk returns a tuple with the StitchAppName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStitchAppName + +`func (o *LineItem) SetStitchAppName(v string)` + +SetStitchAppName sets StitchAppName field to given value. + +### HasStitchAppName + +`func (o *LineItem) HasStitchAppName() bool` + +HasStitchAppName returns a boolean if a field has been set. + +### GetTierLowerBound + +`func (o *LineItem) GetTierLowerBound() float64` + +GetTierLowerBound returns the TierLowerBound field if non-nil, zero value otherwise. + +### GetTierLowerBoundOk + +`func (o *LineItem) GetTierLowerBoundOk() (*float64, bool)` + +GetTierLowerBoundOk returns a tuple with the TierLowerBound field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTierLowerBound + +`func (o *LineItem) SetTierLowerBound(v float64)` + +SetTierLowerBound sets TierLowerBound field to given value. + +### HasTierLowerBound + +`func (o *LineItem) HasTierLowerBound() bool` + +HasTierLowerBound returns a boolean if a field has been set. + +### GetTierUpperBound + +`func (o *LineItem) GetTierUpperBound() float64` + +GetTierUpperBound returns the TierUpperBound field if non-nil, zero value otherwise. + +### GetTierUpperBoundOk + +`func (o *LineItem) GetTierUpperBoundOk() (*float64, bool)` + +GetTierUpperBoundOk returns a tuple with the TierUpperBound field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTierUpperBound + +`func (o *LineItem) SetTierUpperBound(v float64)` + +SetTierUpperBound sets TierUpperBound field to given value. + +### HasTierUpperBound + +`func (o *LineItem) HasTierUpperBound() bool` + +HasTierUpperBound returns a boolean if a field has been set. + +### GetTotalPriceCents + +`func (o *LineItem) GetTotalPriceCents() int64` + +GetTotalPriceCents returns the TotalPriceCents field if non-nil, zero value otherwise. + +### GetTotalPriceCentsOk + +`func (o *LineItem) GetTotalPriceCentsOk() (*int64, bool)` + +GetTotalPriceCentsOk returns a tuple with the TotalPriceCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalPriceCents + +`func (o *LineItem) SetTotalPriceCents(v int64)` + +SetTotalPriceCents sets TotalPriceCents field to given value. + +### HasTotalPriceCents + +`func (o *LineItem) HasTotalPriceCents() bool` + +HasTotalPriceCents returns a boolean if a field has been set. + +### GetUnit + +`func (o *LineItem) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *LineItem) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *LineItem) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *LineItem) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + +### GetUnitPriceDollars + +`func (o *LineItem) GetUnitPriceDollars() float64` + +GetUnitPriceDollars returns the UnitPriceDollars field if non-nil, zero value otherwise. + +### GetUnitPriceDollarsOk + +`func (o *LineItem) GetUnitPriceDollarsOk() (*float64, bool)` + +GetUnitPriceDollarsOk returns a tuple with the UnitPriceDollars field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnitPriceDollars + +`func (o *LineItem) SetUnitPriceDollars(v float64)` + +SetUnitPriceDollars sets UnitPriceDollars field to given value. + +### HasUnitPriceDollars + +`func (o *LineItem) HasUnitPriceDollars() bool` + +HasUnitPriceDollars returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Link.md b/docs/docs/Link.md new file mode 100644 index 00000000..973ff59a --- /dev/null +++ b/docs/docs/Link.md @@ -0,0 +1,82 @@ +# Link + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Href** | Pointer to **string** | Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`. | [optional] +**Rel** | Pointer to **string** | Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`. | [optional] + +## Methods + +### NewLink + +`func NewLink() *Link` + +NewLink instantiates a new Link object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLinkWithDefaults + +`func NewLinkWithDefaults() *Link` + +NewLinkWithDefaults instantiates a new Link object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHref + +`func (o *Link) GetHref() string` + +GetHref returns the Href field if non-nil, zero value otherwise. + +### GetHrefOk + +`func (o *Link) GetHrefOk() (*string, bool)` + +GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHref + +`func (o *Link) SetHref(v string)` + +SetHref sets Href field to given value. + +### HasHref + +`func (o *Link) HasHref() bool` + +HasHref returns a boolean if a field has been set. + +### GetRel + +`func (o *Link) GetRel() string` + +GetRel returns the Rel field if non-nil, zero value otherwise. + +### GetRelOk + +`func (o *Link) GetRelOk() (*string, bool)` + +GetRelOk returns a tuple with the Rel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRel + +`func (o *Link) SetRel(v string)` + +SetRel sets Rel field to given value. + +### HasRel + +`func (o *Link) HasRel() bool` + +HasRel returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LinkAtlas.md b/docs/docs/LinkAtlas.md new file mode 100644 index 00000000..da99058d --- /dev/null +++ b/docs/docs/LinkAtlas.md @@ -0,0 +1,82 @@ +# LinkAtlas + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Href** | Pointer to **string** | Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`. | [optional] +**Rel** | Pointer to **string** | Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`. | [optional] + +## Methods + +### NewLinkAtlas + +`func NewLinkAtlas() *LinkAtlas` + +NewLinkAtlas instantiates a new LinkAtlas object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLinkAtlasWithDefaults + +`func NewLinkAtlasWithDefaults() *LinkAtlas` + +NewLinkAtlasWithDefaults instantiates a new LinkAtlas object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHref + +`func (o *LinkAtlas) GetHref() string` + +GetHref returns the Href field if non-nil, zero value otherwise. + +### GetHrefOk + +`func (o *LinkAtlas) GetHrefOk() (*string, bool)` + +GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHref + +`func (o *LinkAtlas) SetHref(v string)` + +SetHref sets Href field to given value. + +### HasHref + +`func (o *LinkAtlas) HasHref() bool` + +HasHref returns a boolean if a field has been set. + +### GetRel + +`func (o *LinkAtlas) GetRel() string` + +GetRel returns the Rel field if non-nil, zero value otherwise. + +### GetRelOk + +`func (o *LinkAtlas) GetRelOk() (*string, bool)` + +GetRelOk returns a tuple with the Rel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRel + +`func (o *LinkAtlas) SetRel(v string)` + +SetRel sets Rel field to given value. + +### HasRel + +`func (o *LinkAtlas) HasRel() bool` + +HasRel returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ListPeeringConnections200Response.md b/docs/docs/ListPeeringConnections200Response.md new file mode 100644 index 00000000..f3323d9c --- /dev/null +++ b/docs/docs/ListPeeringConnections200Response.md @@ -0,0 +1,108 @@ +# ListPeeringConnections200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]GCPPeerVpc**](GCPPeerVpc.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewListPeeringConnections200Response + +`func NewListPeeringConnections200Response() *ListPeeringConnections200Response` + +NewListPeeringConnections200Response instantiates a new ListPeeringConnections200Response object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewListPeeringConnections200ResponseWithDefaults + +`func NewListPeeringConnections200ResponseWithDefaults() *ListPeeringConnections200Response` + +NewListPeeringConnections200ResponseWithDefaults instantiates a new ListPeeringConnections200Response object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *ListPeeringConnections200Response) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ListPeeringConnections200Response) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ListPeeringConnections200Response) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ListPeeringConnections200Response) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *ListPeeringConnections200Response) GetResults() []GCPPeerVpc` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListPeeringConnections200Response) GetResultsOk() (*[]GCPPeerVpc, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListPeeringConnections200Response) SetResults(v []GCPPeerVpc)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListPeeringConnections200Response) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *ListPeeringConnections200Response) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *ListPeeringConnections200Response) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *ListPeeringConnections200Response) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *ListPeeringConnections200Response) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LiveMigrationRequest.md b/docs/docs/LiveMigrationRequest.md new file mode 100644 index 00000000..95b2f4d3 --- /dev/null +++ b/docs/docs/LiveMigrationRequest.md @@ -0,0 +1,145 @@ +# LiveMigrationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the migration request. | [optional] [readonly] +**Destination** | [**Destination**](Destination.md) | | +**DropEnabled** | **bool** | Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts. | +**MigrationHosts** | Pointer to **[]string** | List of migration hosts used for this migration. | [optional] +**Source** | [**Source**](Source.md) | | + +## Methods + +### NewLiveMigrationRequest + +`func NewLiveMigrationRequest(destination Destination, dropEnabled bool, source Source, ) *LiveMigrationRequest` + +NewLiveMigrationRequest instantiates a new LiveMigrationRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLiveMigrationRequestWithDefaults + +`func NewLiveMigrationRequestWithDefaults() *LiveMigrationRequest` + +NewLiveMigrationRequestWithDefaults instantiates a new LiveMigrationRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *LiveMigrationRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LiveMigrationRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LiveMigrationRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LiveMigrationRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDestination + +`func (o *LiveMigrationRequest) GetDestination() Destination` + +GetDestination returns the Destination field if non-nil, zero value otherwise. + +### GetDestinationOk + +`func (o *LiveMigrationRequest) GetDestinationOk() (*Destination, bool)` + +GetDestinationOk returns a tuple with the Destination field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDestination + +`func (o *LiveMigrationRequest) SetDestination(v Destination)` + +SetDestination sets Destination field to given value. + + +### GetDropEnabled + +`func (o *LiveMigrationRequest) GetDropEnabled() bool` + +GetDropEnabled returns the DropEnabled field if non-nil, zero value otherwise. + +### GetDropEnabledOk + +`func (o *LiveMigrationRequest) GetDropEnabledOk() (*bool, bool)` + +GetDropEnabledOk returns a tuple with the DropEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDropEnabled + +`func (o *LiveMigrationRequest) SetDropEnabled(v bool)` + +SetDropEnabled sets DropEnabled field to given value. + + +### GetMigrationHosts + +`func (o *LiveMigrationRequest) GetMigrationHosts() []string` + +GetMigrationHosts returns the MigrationHosts field if non-nil, zero value otherwise. + +### GetMigrationHostsOk + +`func (o *LiveMigrationRequest) GetMigrationHostsOk() (*[]string, bool)` + +GetMigrationHostsOk returns a tuple with the MigrationHosts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMigrationHosts + +`func (o *LiveMigrationRequest) SetMigrationHosts(v []string)` + +SetMigrationHosts sets MigrationHosts field to given value. + +### HasMigrationHosts + +`func (o *LiveMigrationRequest) HasMigrationHosts() bool` + +HasMigrationHosts returns a boolean if a field has been set. + +### GetSource + +`func (o *LiveMigrationRequest) GetSource() Source` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *LiveMigrationRequest) GetSourceOk() (*Source, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *LiveMigrationRequest) SetSource(v Source)` + +SetSource sets Source field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/LiveMigrationResponse.md b/docs/docs/LiveMigrationResponse.md new file mode 100644 index 00000000..aed3a3a3 --- /dev/null +++ b/docs/docs/LiveMigrationResponse.md @@ -0,0 +1,170 @@ +# LiveMigrationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the migration job. | [optional] [readonly] +**LagTimeSeconds** | Pointer to **NullableInt64** | Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase. | [optional] [readonly] +**MigrationHosts** | Pointer to **[]string** | List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one target cluster. | [optional] [readonly] +**ReadyForCutover** | Pointer to **bool** | Flag that indicates the migrated cluster can be cut over to MongoDB Atlas. | [optional] [readonly] +**Status** | Pointer to **string** | Progress made in migrating one cluster to MongoDB Atlas. | Status | Explanation | |----------|-------------| | NEW | Someone scheduled a local cluster migration to MongoDB Atlas. | | FAILED | The cluster migration to MongoDB Atlas failed. | | COMPLETE | The cluster migration to MongoDB Atlas succeeded. | | EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and target clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. | | WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:<ul><li>Preparing connections to source and target clusters</li><li>Replicating data from source to target</li><li>Verifying MongoDB Atlas connection settings</li><li>Stopping replication after the cut over</li></ul> | | [optional] [readonly] + +## Methods + +### NewLiveMigrationResponse + +`func NewLiveMigrationResponse() *LiveMigrationResponse` + +NewLiveMigrationResponse instantiates a new LiveMigrationResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLiveMigrationResponseWithDefaults + +`func NewLiveMigrationResponseWithDefaults() *LiveMigrationResponse` + +NewLiveMigrationResponseWithDefaults instantiates a new LiveMigrationResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *LiveMigrationResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LiveMigrationResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LiveMigrationResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LiveMigrationResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLagTimeSeconds + +`func (o *LiveMigrationResponse) GetLagTimeSeconds() int64` + +GetLagTimeSeconds returns the LagTimeSeconds field if non-nil, zero value otherwise. + +### GetLagTimeSecondsOk + +`func (o *LiveMigrationResponse) GetLagTimeSecondsOk() (*int64, bool)` + +GetLagTimeSecondsOk returns a tuple with the LagTimeSeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLagTimeSeconds + +`func (o *LiveMigrationResponse) SetLagTimeSeconds(v int64)` + +SetLagTimeSeconds sets LagTimeSeconds field to given value. + +### HasLagTimeSeconds + +`func (o *LiveMigrationResponse) HasLagTimeSeconds() bool` + +HasLagTimeSeconds returns a boolean if a field has been set. + +### SetLagTimeSecondsNil + +`func (o *LiveMigrationResponse) SetLagTimeSecondsNil(b bool)` + + SetLagTimeSecondsNil sets the value for LagTimeSeconds to be an explicit nil + +### UnsetLagTimeSeconds +`func (o *LiveMigrationResponse) UnsetLagTimeSeconds()` + +UnsetLagTimeSeconds ensures that no value is present for LagTimeSeconds, not even an explicit nil +### GetMigrationHosts + +`func (o *LiveMigrationResponse) GetMigrationHosts() []string` + +GetMigrationHosts returns the MigrationHosts field if non-nil, zero value otherwise. + +### GetMigrationHostsOk + +`func (o *LiveMigrationResponse) GetMigrationHostsOk() (*[]string, bool)` + +GetMigrationHostsOk returns a tuple with the MigrationHosts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMigrationHosts + +`func (o *LiveMigrationResponse) SetMigrationHosts(v []string)` + +SetMigrationHosts sets MigrationHosts field to given value. + +### HasMigrationHosts + +`func (o *LiveMigrationResponse) HasMigrationHosts() bool` + +HasMigrationHosts returns a boolean if a field has been set. + +### GetReadyForCutover + +`func (o *LiveMigrationResponse) GetReadyForCutover() bool` + +GetReadyForCutover returns the ReadyForCutover field if non-nil, zero value otherwise. + +### GetReadyForCutoverOk + +`func (o *LiveMigrationResponse) GetReadyForCutoverOk() (*bool, bool)` + +GetReadyForCutoverOk returns a tuple with the ReadyForCutover field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadyForCutover + +`func (o *LiveMigrationResponse) SetReadyForCutover(v bool)` + +SetReadyForCutover sets ReadyForCutover field to given value. + +### HasReadyForCutover + +`func (o *LiveMigrationResponse) HasReadyForCutover() bool` + +HasReadyForCutover returns a boolean if a field has been set. + +### GetStatus + +`func (o *LiveMigrationResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *LiveMigrationResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *LiveMigrationResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *LiveMigrationResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MaintenanceWindowsApi.md b/docs/docs/MaintenanceWindowsApi.md new file mode 100644 index 00000000..dcd72177 --- /dev/null +++ b/docs/docs/MaintenanceWindowsApi.md @@ -0,0 +1,377 @@ +# \MaintenanceWindowsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**DeferMaintenanceWindow**](MaintenanceWindowsApi.md#DeferMaintenanceWindow) | **Post** /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer | Defer One Maintenance Window for One Project +[**GetMaintenanceWindow**](MaintenanceWindowsApi.md#GetMaintenanceWindow) | **Get** /api/atlas/v2/groups/{groupId}/maintenanceWindow | Return One Maintenance Window for One Project +[**ResetMaintenanceWindow**](MaintenanceWindowsApi.md#ResetMaintenanceWindow) | **Delete** /api/atlas/v2/groups/{groupId}/maintenanceWindow | Reset One Maintenance Window for One Project +[**ToggleMaintenanceAutoDefer**](MaintenanceWindowsApi.md#ToggleMaintenanceAutoDefer) | **Post** /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer | Toggle Automatic Deferral of Maintenance for One Project +[**UpdateMaintenanceWindow**](MaintenanceWindowsApi.md#UpdateMaintenanceWindow) | **Patch** /api/atlas/v2/groups/{groupId}/maintenanceWindow | Update Maintenance Window for One Project + + + +## DeferMaintenanceWindow + +> DeferMaintenanceWindow(ctx, groupId).Execute() + +Defer One Maintenance Window for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.MaintenanceWindowsApi.DeferMaintenanceWindow(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MaintenanceWindowsApi.DeferMaintenanceWindow``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeferMaintenanceWindowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetMaintenanceWindow + +> GroupMaintenanceWindow GetMaintenanceWindow(ctx, groupId).Execute() + +Return One Maintenance Window for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.MaintenanceWindowsApi.GetMaintenanceWindow(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MaintenanceWindowsApi.GetMaintenanceWindow``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetMaintenanceWindow`: GroupMaintenanceWindow + fmt.Fprintf(os.Stdout, "Response from `MaintenanceWindowsApi.GetMaintenanceWindow`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMaintenanceWindowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GroupMaintenanceWindow**](GroupMaintenanceWindow.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ResetMaintenanceWindow + +> ResetMaintenanceWindow(ctx, groupId).Execute() + +Reset One Maintenance Window for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.MaintenanceWindowsApi.ResetMaintenanceWindow(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MaintenanceWindowsApi.ResetMaintenanceWindow``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetMaintenanceWindowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ToggleMaintenanceAutoDefer + +> ToggleMaintenanceAutoDefer(ctx, groupId).Execute() + +Toggle Automatic Deferral of Maintenance for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.MaintenanceWindowsApi.ToggleMaintenanceAutoDefer(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MaintenanceWindowsApi.ToggleMaintenanceAutoDefer``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiToggleMaintenanceAutoDeferRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateMaintenanceWindow + +> UpdateMaintenanceWindow(ctx, groupId).GroupMaintenanceWindow(groupMaintenanceWindow).Execute() + +Update Maintenance Window for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + groupMaintenanceWindow := *openapiclient.NewGroupMaintenanceWindow(int(123), int(123)) // GroupMaintenanceWindow | + + r, err := sdk.MaintenanceWindowsApi.UpdateMaintenanceWindow(context.Background(), groupId).GroupMaintenanceWindow(groupMaintenanceWindow).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MaintenanceWindowsApi.UpdateMaintenanceWindow``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMaintenanceWindowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **groupMaintenanceWindow** | [**GroupMaintenanceWindow**](GroupMaintenanceWindow.md) | Updates the maintenance window for the specified project. | + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ManagedNamespace.md b/docs/docs/ManagedNamespace.md new file mode 100644 index 00000000..5bb9ec1f --- /dev/null +++ b/docs/docs/ManagedNamespace.md @@ -0,0 +1,212 @@ +# ManagedNamespace + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Collection** | Pointer to **string** | Human-readable label of the collection to manage for this Global Cluster. | [optional] +**CustomShardKey** | Pointer to **string** | Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key. | [optional] +**Db** | Pointer to **string** | Human-readable label of the database to manage for this Global Cluster. | [optional] +**IsCustomShardKeyHashed** | Pointer to **bool** | Flag that indicates whether someone hashed the custom shard key. If this parameter returns `false`, this cluster uses ranged sharding. | [optional] [default to false] +**IsShardKeyUnique** | Pointer to **bool** | Flag that indicates whether the underlying index enforces unique values. | [optional] [default to false] +**NumInitialChunks** | Pointer to **int64** | Minimum number of chunks to create initially when sharding an empty collection with a hashed shard key. | [optional] +**PresplitHashedZones** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection. | [optional] [default to false] + +## Methods + +### NewManagedNamespace + +`func NewManagedNamespace() *ManagedNamespace` + +NewManagedNamespace instantiates a new ManagedNamespace object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewManagedNamespaceWithDefaults + +`func NewManagedNamespaceWithDefaults() *ManagedNamespace` + +NewManagedNamespaceWithDefaults instantiates a new ManagedNamespace object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCollection + +`func (o *ManagedNamespace) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *ManagedNamespace) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *ManagedNamespace) SetCollection(v string)` + +SetCollection sets Collection field to given value. + +### HasCollection + +`func (o *ManagedNamespace) HasCollection() bool` + +HasCollection returns a boolean if a field has been set. + +### GetCustomShardKey + +`func (o *ManagedNamespace) GetCustomShardKey() string` + +GetCustomShardKey returns the CustomShardKey field if non-nil, zero value otherwise. + +### GetCustomShardKeyOk + +`func (o *ManagedNamespace) GetCustomShardKeyOk() (*string, bool)` + +GetCustomShardKeyOk returns a tuple with the CustomShardKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomShardKey + +`func (o *ManagedNamespace) SetCustomShardKey(v string)` + +SetCustomShardKey sets CustomShardKey field to given value. + +### HasCustomShardKey + +`func (o *ManagedNamespace) HasCustomShardKey() bool` + +HasCustomShardKey returns a boolean if a field has been set. + +### GetDb + +`func (o *ManagedNamespace) GetDb() string` + +GetDb returns the Db field if non-nil, zero value otherwise. + +### GetDbOk + +`func (o *ManagedNamespace) GetDbOk() (*string, bool)` + +GetDbOk returns a tuple with the Db field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDb + +`func (o *ManagedNamespace) SetDb(v string)` + +SetDb sets Db field to given value. + +### HasDb + +`func (o *ManagedNamespace) HasDb() bool` + +HasDb returns a boolean if a field has been set. + +### GetIsCustomShardKeyHashed + +`func (o *ManagedNamespace) GetIsCustomShardKeyHashed() bool` + +GetIsCustomShardKeyHashed returns the IsCustomShardKeyHashed field if non-nil, zero value otherwise. + +### GetIsCustomShardKeyHashedOk + +`func (o *ManagedNamespace) GetIsCustomShardKeyHashedOk() (*bool, bool)` + +GetIsCustomShardKeyHashedOk returns a tuple with the IsCustomShardKeyHashed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsCustomShardKeyHashed + +`func (o *ManagedNamespace) SetIsCustomShardKeyHashed(v bool)` + +SetIsCustomShardKeyHashed sets IsCustomShardKeyHashed field to given value. + +### HasIsCustomShardKeyHashed + +`func (o *ManagedNamespace) HasIsCustomShardKeyHashed() bool` + +HasIsCustomShardKeyHashed returns a boolean if a field has been set. + +### GetIsShardKeyUnique + +`func (o *ManagedNamespace) GetIsShardKeyUnique() bool` + +GetIsShardKeyUnique returns the IsShardKeyUnique field if non-nil, zero value otherwise. + +### GetIsShardKeyUniqueOk + +`func (o *ManagedNamespace) GetIsShardKeyUniqueOk() (*bool, bool)` + +GetIsShardKeyUniqueOk returns a tuple with the IsShardKeyUnique field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsShardKeyUnique + +`func (o *ManagedNamespace) SetIsShardKeyUnique(v bool)` + +SetIsShardKeyUnique sets IsShardKeyUnique field to given value. + +### HasIsShardKeyUnique + +`func (o *ManagedNamespace) HasIsShardKeyUnique() bool` + +HasIsShardKeyUnique returns a boolean if a field has been set. + +### GetNumInitialChunks + +`func (o *ManagedNamespace) GetNumInitialChunks() int64` + +GetNumInitialChunks returns the NumInitialChunks field if non-nil, zero value otherwise. + +### GetNumInitialChunksOk + +`func (o *ManagedNamespace) GetNumInitialChunksOk() (*int64, bool)` + +GetNumInitialChunksOk returns a tuple with the NumInitialChunks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumInitialChunks + +`func (o *ManagedNamespace) SetNumInitialChunks(v int64)` + +SetNumInitialChunks sets NumInitialChunks field to given value. + +### HasNumInitialChunks + +`func (o *ManagedNamespace) HasNumInitialChunks() bool` + +HasNumInitialChunks returns a boolean if a field has been set. + +### GetPresplitHashedZones + +`func (o *ManagedNamespace) GetPresplitHashedZones() bool` + +GetPresplitHashedZones returns the PresplitHashedZones field if non-nil, zero value otherwise. + +### GetPresplitHashedZonesOk + +`func (o *ManagedNamespace) GetPresplitHashedZonesOk() (*bool, bool)` + +GetPresplitHashedZonesOk returns a tuple with the PresplitHashedZones field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPresplitHashedZones + +`func (o *ManagedNamespace) SetPresplitHashedZones(v bool)` + +SetPresplitHashedZones sets PresplitHashedZones field to given value. + +### HasPresplitHashedZones + +`func (o *ManagedNamespace) HasPresplitHashedZones() bool` + +HasPresplitHashedZones returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ManagedNamespaces.md b/docs/docs/ManagedNamespaces.md new file mode 100644 index 00000000..7731148f --- /dev/null +++ b/docs/docs/ManagedNamespaces.md @@ -0,0 +1,197 @@ +# ManagedNamespaces + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Collection** | **string** | Human-readable label of the collection to manage for this Global Cluster. | +**CustomShardKey** | **string** | Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key. | [readonly] +**Db** | **string** | Human-readable label of the database to manage for this Global Cluster. | +**IsCustomShardKeyHashed** | Pointer to **bool** | Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding. | [optional] [default to false] +**IsShardKeyUnique** | Pointer to **bool** | Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/). | [optional] [default to false] +**NumInitialChunks** | Pointer to **int64** | Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/). | [optional] +**PresplitHashedZones** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection. | [optional] [default to false] + +## Methods + +### NewManagedNamespaces + +`func NewManagedNamespaces(collection string, customShardKey string, db string, ) *ManagedNamespaces` + +NewManagedNamespaces instantiates a new ManagedNamespaces object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewManagedNamespacesWithDefaults + +`func NewManagedNamespacesWithDefaults() *ManagedNamespaces` + +NewManagedNamespacesWithDefaults instantiates a new ManagedNamespaces object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCollection + +`func (o *ManagedNamespaces) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *ManagedNamespaces) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *ManagedNamespaces) SetCollection(v string)` + +SetCollection sets Collection field to given value. + + +### GetCustomShardKey + +`func (o *ManagedNamespaces) GetCustomShardKey() string` + +GetCustomShardKey returns the CustomShardKey field if non-nil, zero value otherwise. + +### GetCustomShardKeyOk + +`func (o *ManagedNamespaces) GetCustomShardKeyOk() (*string, bool)` + +GetCustomShardKeyOk returns a tuple with the CustomShardKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomShardKey + +`func (o *ManagedNamespaces) SetCustomShardKey(v string)` + +SetCustomShardKey sets CustomShardKey field to given value. + + +### GetDb + +`func (o *ManagedNamespaces) GetDb() string` + +GetDb returns the Db field if non-nil, zero value otherwise. + +### GetDbOk + +`func (o *ManagedNamespaces) GetDbOk() (*string, bool)` + +GetDbOk returns a tuple with the Db field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDb + +`func (o *ManagedNamespaces) SetDb(v string)` + +SetDb sets Db field to given value. + + +### GetIsCustomShardKeyHashed + +`func (o *ManagedNamespaces) GetIsCustomShardKeyHashed() bool` + +GetIsCustomShardKeyHashed returns the IsCustomShardKeyHashed field if non-nil, zero value otherwise. + +### GetIsCustomShardKeyHashedOk + +`func (o *ManagedNamespaces) GetIsCustomShardKeyHashedOk() (*bool, bool)` + +GetIsCustomShardKeyHashedOk returns a tuple with the IsCustomShardKeyHashed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsCustomShardKeyHashed + +`func (o *ManagedNamespaces) SetIsCustomShardKeyHashed(v bool)` + +SetIsCustomShardKeyHashed sets IsCustomShardKeyHashed field to given value. + +### HasIsCustomShardKeyHashed + +`func (o *ManagedNamespaces) HasIsCustomShardKeyHashed() bool` + +HasIsCustomShardKeyHashed returns a boolean if a field has been set. + +### GetIsShardKeyUnique + +`func (o *ManagedNamespaces) GetIsShardKeyUnique() bool` + +GetIsShardKeyUnique returns the IsShardKeyUnique field if non-nil, zero value otherwise. + +### GetIsShardKeyUniqueOk + +`func (o *ManagedNamespaces) GetIsShardKeyUniqueOk() (*bool, bool)` + +GetIsShardKeyUniqueOk returns a tuple with the IsShardKeyUnique field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsShardKeyUnique + +`func (o *ManagedNamespaces) SetIsShardKeyUnique(v bool)` + +SetIsShardKeyUnique sets IsShardKeyUnique field to given value. + +### HasIsShardKeyUnique + +`func (o *ManagedNamespaces) HasIsShardKeyUnique() bool` + +HasIsShardKeyUnique returns a boolean if a field has been set. + +### GetNumInitialChunks + +`func (o *ManagedNamespaces) GetNumInitialChunks() int64` + +GetNumInitialChunks returns the NumInitialChunks field if non-nil, zero value otherwise. + +### GetNumInitialChunksOk + +`func (o *ManagedNamespaces) GetNumInitialChunksOk() (*int64, bool)` + +GetNumInitialChunksOk returns a tuple with the NumInitialChunks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumInitialChunks + +`func (o *ManagedNamespaces) SetNumInitialChunks(v int64)` + +SetNumInitialChunks sets NumInitialChunks field to given value. + +### HasNumInitialChunks + +`func (o *ManagedNamespaces) HasNumInitialChunks() bool` + +HasNumInitialChunks returns a boolean if a field has been set. + +### GetPresplitHashedZones + +`func (o *ManagedNamespaces) GetPresplitHashedZones() bool` + +GetPresplitHashedZones returns the PresplitHashedZones field if non-nil, zero value otherwise. + +### GetPresplitHashedZonesOk + +`func (o *ManagedNamespaces) GetPresplitHashedZonesOk() (*bool, bool)` + +GetPresplitHashedZonesOk returns a tuple with the PresplitHashedZones field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPresplitHashedZones + +`func (o *ManagedNamespaces) SetPresplitHashedZones(v bool)` + +SetPresplitHashedZones sets PresplitHashedZones field to given value. + +### HasPresplitHashedZones + +`func (o *ManagedNamespaces) HasPresplitHashedZones() bool` + +HasPresplitHashedZones returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MatcherField.md b/docs/docs/MatcherField.md new file mode 100644 index 00000000..1dac43e9 --- /dev/null +++ b/docs/docs/MatcherField.md @@ -0,0 +1,25 @@ +# MatcherField + +## Enum + + +* `APPLICATION_ID` (value: `"APPLICATION_ID"`) + +* `CLUSTER_NAME` (value: `"CLUSTER_NAME"`) + +* `TYPE_NAME` (value: `"TYPE_NAME"`) + +* `HOSTNAME` (value: `"HOSTNAME"`) + +* `PORT` (value: `"PORT"`) + +* `HOSTNAME_AND_PORT` (value: `"HOSTNAME_AND_PORT"`) + +* `REPLICA_SET_NAME` (value: `"REPLICA_SET_NAME"`) + +* `SHARD_NAME` (value: `"SHARD_NAME"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MatcherHostType.md b/docs/docs/MatcherHostType.md new file mode 100644 index 00000000..91b2e236 --- /dev/null +++ b/docs/docs/MatcherHostType.md @@ -0,0 +1,21 @@ +# MatcherHostType + +## Enum + + +* `STANDALONE` (value: `"STANDALONE"`) + +* `PRIMARY` (value: `"PRIMARY"`) + +* `SECONDARY` (value: `"SECONDARY"`) + +* `ARBITER` (value: `"ARBITER"`) + +* `MONGOS` (value: `"MONGOS"`) + +* `CONFIG` (value: `"CONFIG"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Measurement.md b/docs/docs/Measurement.md new file mode 100644 index 00000000..3acb708a --- /dev/null +++ b/docs/docs/Measurement.md @@ -0,0 +1,108 @@ +# Measurement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataPoints** | Pointer to [**[]MetricDataPoint**](MetricDataPoint.md) | List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label of the measurement that this data point covers. | [optional] [readonly] +**Units** | Pointer to **string** | Element used to quantify the measurement. The resource returns units of throughput, storage, and time. | [optional] [readonly] + +## Methods + +### NewMeasurement + +`func NewMeasurement() *Measurement` + +NewMeasurement instantiates a new Measurement object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMeasurementWithDefaults + +`func NewMeasurementWithDefaults() *Measurement` + +NewMeasurementWithDefaults instantiates a new Measurement object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDataPoints + +`func (o *Measurement) GetDataPoints() []MetricDataPoint` + +GetDataPoints returns the DataPoints field if non-nil, zero value otherwise. + +### GetDataPointsOk + +`func (o *Measurement) GetDataPointsOk() (*[]MetricDataPoint, bool)` + +GetDataPointsOk returns a tuple with the DataPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataPoints + +`func (o *Measurement) SetDataPoints(v []MetricDataPoint)` + +SetDataPoints sets DataPoints field to given value. + +### HasDataPoints + +`func (o *Measurement) HasDataPoints() bool` + +HasDataPoints returns a boolean if a field has been set. + +### GetName + +`func (o *Measurement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Measurement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Measurement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Measurement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUnits + +`func (o *Measurement) GetUnits() string` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *Measurement) GetUnitsOk() (*string, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *Measurement) SetUnits(v string)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *Measurement) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MeasurementViewAtlas.md b/docs/docs/MeasurementViewAtlas.md new file mode 100644 index 00000000..b2be0f0d --- /dev/null +++ b/docs/docs/MeasurementViewAtlas.md @@ -0,0 +1,108 @@ +# MeasurementViewAtlas + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataPoints** | Pointer to [**[]MetricDataPointViewAtlas**](MetricDataPointViewAtlas.md) | List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label of the measurement that this data point covers. | [optional] [readonly] +**Units** | Pointer to **string** | Element used to quantify the measurement. The resource returns units of throughput, storage, and time. | [optional] [readonly] + +## Methods + +### NewMeasurementViewAtlas + +`func NewMeasurementViewAtlas() *MeasurementViewAtlas` + +NewMeasurementViewAtlas instantiates a new MeasurementViewAtlas object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMeasurementViewAtlasWithDefaults + +`func NewMeasurementViewAtlasWithDefaults() *MeasurementViewAtlas` + +NewMeasurementViewAtlasWithDefaults instantiates a new MeasurementViewAtlas object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDataPoints + +`func (o *MeasurementViewAtlas) GetDataPoints() []MetricDataPointViewAtlas` + +GetDataPoints returns the DataPoints field if non-nil, zero value otherwise. + +### GetDataPointsOk + +`func (o *MeasurementViewAtlas) GetDataPointsOk() (*[]MetricDataPointViewAtlas, bool)` + +GetDataPointsOk returns a tuple with the DataPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataPoints + +`func (o *MeasurementViewAtlas) SetDataPoints(v []MetricDataPointViewAtlas)` + +SetDataPoints sets DataPoints field to given value. + +### HasDataPoints + +`func (o *MeasurementViewAtlas) HasDataPoints() bool` + +HasDataPoints returns a boolean if a field has been set. + +### GetName + +`func (o *MeasurementViewAtlas) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MeasurementViewAtlas) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MeasurementViewAtlas) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MeasurementViewAtlas) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUnits + +`func (o *MeasurementViewAtlas) GetUnits() string` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *MeasurementViewAtlas) GetUnitsOk() (*string, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *MeasurementViewAtlas) SetUnits(v string)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *MeasurementViewAtlas) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MeasurementsGeneralViewAtlas.md b/docs/docs/MeasurementsGeneralViewAtlas.md new file mode 100644 index 00000000..846c86ba --- /dev/null +++ b/docs/docs/MeasurementsGeneralViewAtlas.md @@ -0,0 +1,290 @@ +# MeasurementsGeneralViewAtlas + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DatabaseName** | Pointer to **string** | Human-readable label that identifies the database that the specified MongoDB process serves. | [optional] [readonly] +**End** | Pointer to **time.Time** | Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Granularity** | Pointer to **string** | Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. | [optional] [readonly] +**HostId** | Pointer to **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**Links** | Pointer to [**[]LinkAtlas**](LinkAtlas.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Measurements** | Pointer to [**[]MeasurementViewAtlas**](MeasurementViewAtlas.md) | List that contains measurements and their data points. | [optional] [readonly] +**PartitionName** | Pointer to **string** | Human-readable label of the disk or partition to which the measurements apply. | [optional] [readonly] +**ProcessId** | Pointer to **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**Start** | Pointer to **time.Time** | Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewMeasurementsGeneralViewAtlas + +`func NewMeasurementsGeneralViewAtlas() *MeasurementsGeneralViewAtlas` + +NewMeasurementsGeneralViewAtlas instantiates a new MeasurementsGeneralViewAtlas object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMeasurementsGeneralViewAtlasWithDefaults + +`func NewMeasurementsGeneralViewAtlasWithDefaults() *MeasurementsGeneralViewAtlas` + +NewMeasurementsGeneralViewAtlasWithDefaults instantiates a new MeasurementsGeneralViewAtlas object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDatabaseName + +`func (o *MeasurementsGeneralViewAtlas) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *MeasurementsGeneralViewAtlas) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *MeasurementsGeneralViewAtlas) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + +### HasDatabaseName + +`func (o *MeasurementsGeneralViewAtlas) HasDatabaseName() bool` + +HasDatabaseName returns a boolean if a field has been set. + +### GetEnd + +`func (o *MeasurementsGeneralViewAtlas) GetEnd() time.Time` + +GetEnd returns the End field if non-nil, zero value otherwise. + +### GetEndOk + +`func (o *MeasurementsGeneralViewAtlas) GetEndOk() (*time.Time, bool)` + +GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnd + +`func (o *MeasurementsGeneralViewAtlas) SetEnd(v time.Time)` + +SetEnd sets End field to given value. + +### HasEnd + +`func (o *MeasurementsGeneralViewAtlas) HasEnd() bool` + +HasEnd returns a boolean if a field has been set. + +### GetGranularity + +`func (o *MeasurementsGeneralViewAtlas) GetGranularity() string` + +GetGranularity returns the Granularity field if non-nil, zero value otherwise. + +### GetGranularityOk + +`func (o *MeasurementsGeneralViewAtlas) GetGranularityOk() (*string, bool)` + +GetGranularityOk returns a tuple with the Granularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGranularity + +`func (o *MeasurementsGeneralViewAtlas) SetGranularity(v string)` + +SetGranularity sets Granularity field to given value. + +### HasGranularity + +`func (o *MeasurementsGeneralViewAtlas) HasGranularity() bool` + +HasGranularity returns a boolean if a field has been set. + +### GetGroupId + +`func (o *MeasurementsGeneralViewAtlas) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *MeasurementsGeneralViewAtlas) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *MeasurementsGeneralViewAtlas) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *MeasurementsGeneralViewAtlas) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostId + +`func (o *MeasurementsGeneralViewAtlas) GetHostId() string` + +GetHostId returns the HostId field if non-nil, zero value otherwise. + +### GetHostIdOk + +`func (o *MeasurementsGeneralViewAtlas) GetHostIdOk() (*string, bool)` + +GetHostIdOk returns a tuple with the HostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostId + +`func (o *MeasurementsGeneralViewAtlas) SetHostId(v string)` + +SetHostId sets HostId field to given value. + +### HasHostId + +`func (o *MeasurementsGeneralViewAtlas) HasHostId() bool` + +HasHostId returns a boolean if a field has been set. + +### GetLinks + +`func (o *MeasurementsGeneralViewAtlas) GetLinks() []LinkAtlas` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *MeasurementsGeneralViewAtlas) GetLinksOk() (*[]LinkAtlas, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *MeasurementsGeneralViewAtlas) SetLinks(v []LinkAtlas)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *MeasurementsGeneralViewAtlas) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMeasurements + +`func (o *MeasurementsGeneralViewAtlas) GetMeasurements() []MeasurementViewAtlas` + +GetMeasurements returns the Measurements field if non-nil, zero value otherwise. + +### GetMeasurementsOk + +`func (o *MeasurementsGeneralViewAtlas) GetMeasurementsOk() (*[]MeasurementViewAtlas, bool)` + +GetMeasurementsOk returns a tuple with the Measurements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMeasurements + +`func (o *MeasurementsGeneralViewAtlas) SetMeasurements(v []MeasurementViewAtlas)` + +SetMeasurements sets Measurements field to given value. + +### HasMeasurements + +`func (o *MeasurementsGeneralViewAtlas) HasMeasurements() bool` + +HasMeasurements returns a boolean if a field has been set. + +### GetPartitionName + +`func (o *MeasurementsGeneralViewAtlas) GetPartitionName() string` + +GetPartitionName returns the PartitionName field if non-nil, zero value otherwise. + +### GetPartitionNameOk + +`func (o *MeasurementsGeneralViewAtlas) GetPartitionNameOk() (*string, bool)` + +GetPartitionNameOk returns a tuple with the PartitionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartitionName + +`func (o *MeasurementsGeneralViewAtlas) SetPartitionName(v string)` + +SetPartitionName sets PartitionName field to given value. + +### HasPartitionName + +`func (o *MeasurementsGeneralViewAtlas) HasPartitionName() bool` + +HasPartitionName returns a boolean if a field has been set. + +### GetProcessId + +`func (o *MeasurementsGeneralViewAtlas) GetProcessId() string` + +GetProcessId returns the ProcessId field if non-nil, zero value otherwise. + +### GetProcessIdOk + +`func (o *MeasurementsGeneralViewAtlas) GetProcessIdOk() (*string, bool)` + +GetProcessIdOk returns a tuple with the ProcessId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessId + +`func (o *MeasurementsGeneralViewAtlas) SetProcessId(v string)` + +SetProcessId sets ProcessId field to given value. + +### HasProcessId + +`func (o *MeasurementsGeneralViewAtlas) HasProcessId() bool` + +HasProcessId returns a boolean if a field has been set. + +### GetStart + +`func (o *MeasurementsGeneralViewAtlas) GetStart() time.Time` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *MeasurementsGeneralViewAtlas) GetStartOk() (*time.Time, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *MeasurementsGeneralViewAtlas) SetStart(v time.Time)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *MeasurementsGeneralViewAtlas) HasStart() bool` + +HasStart returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MeasurementsIndexes.md b/docs/docs/MeasurementsIndexes.md new file mode 100644 index 00000000..fd9acca6 --- /dev/null +++ b/docs/docs/MeasurementsIndexes.md @@ -0,0 +1,290 @@ +# MeasurementsIndexes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CollectionName** | Pointer to **string** | Human-readable label that identifies the collection. | [optional] [readonly] +**DatabaseName** | Pointer to **string** | Human-readable label that identifies the database that the specified MongoDB process serves. | [optional] [readonly] +**End** | Pointer to **time.Time** | Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Granularity** | Pointer to **string** | Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. | [optional] [readonly] +**IndexIds** | Pointer to **[]string** | List that contains the Atlas Search index identifiers. | [optional] [readonly] +**IndexStatsMeasurements** | Pointer to [**[]Measurement**](Measurement.md) | List that contains the Atlas Search index stats measurements. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**ProcessId** | Pointer to **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**Start** | Pointer to **time.Time** | Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewMeasurementsIndexes + +`func NewMeasurementsIndexes() *MeasurementsIndexes` + +NewMeasurementsIndexes instantiates a new MeasurementsIndexes object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMeasurementsIndexesWithDefaults + +`func NewMeasurementsIndexesWithDefaults() *MeasurementsIndexes` + +NewMeasurementsIndexesWithDefaults instantiates a new MeasurementsIndexes object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCollectionName + +`func (o *MeasurementsIndexes) GetCollectionName() string` + +GetCollectionName returns the CollectionName field if non-nil, zero value otherwise. + +### GetCollectionNameOk + +`func (o *MeasurementsIndexes) GetCollectionNameOk() (*string, bool)` + +GetCollectionNameOk returns a tuple with the CollectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionName + +`func (o *MeasurementsIndexes) SetCollectionName(v string)` + +SetCollectionName sets CollectionName field to given value. + +### HasCollectionName + +`func (o *MeasurementsIndexes) HasCollectionName() bool` + +HasCollectionName returns a boolean if a field has been set. + +### GetDatabaseName + +`func (o *MeasurementsIndexes) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *MeasurementsIndexes) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *MeasurementsIndexes) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + +### HasDatabaseName + +`func (o *MeasurementsIndexes) HasDatabaseName() bool` + +HasDatabaseName returns a boolean if a field has been set. + +### GetEnd + +`func (o *MeasurementsIndexes) GetEnd() time.Time` + +GetEnd returns the End field if non-nil, zero value otherwise. + +### GetEndOk + +`func (o *MeasurementsIndexes) GetEndOk() (*time.Time, bool)` + +GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnd + +`func (o *MeasurementsIndexes) SetEnd(v time.Time)` + +SetEnd sets End field to given value. + +### HasEnd + +`func (o *MeasurementsIndexes) HasEnd() bool` + +HasEnd returns a boolean if a field has been set. + +### GetGranularity + +`func (o *MeasurementsIndexes) GetGranularity() string` + +GetGranularity returns the Granularity field if non-nil, zero value otherwise. + +### GetGranularityOk + +`func (o *MeasurementsIndexes) GetGranularityOk() (*string, bool)` + +GetGranularityOk returns a tuple with the Granularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGranularity + +`func (o *MeasurementsIndexes) SetGranularity(v string)` + +SetGranularity sets Granularity field to given value. + +### HasGranularity + +`func (o *MeasurementsIndexes) HasGranularity() bool` + +HasGranularity returns a boolean if a field has been set. + +### GetGroupId + +`func (o *MeasurementsIndexes) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *MeasurementsIndexes) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *MeasurementsIndexes) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *MeasurementsIndexes) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetIndexIds + +`func (o *MeasurementsIndexes) GetIndexIds() []string` + +GetIndexIds returns the IndexIds field if non-nil, zero value otherwise. + +### GetIndexIdsOk + +`func (o *MeasurementsIndexes) GetIndexIdsOk() (*[]string, bool)` + +GetIndexIdsOk returns a tuple with the IndexIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndexIds + +`func (o *MeasurementsIndexes) SetIndexIds(v []string)` + +SetIndexIds sets IndexIds field to given value. + +### HasIndexIds + +`func (o *MeasurementsIndexes) HasIndexIds() bool` + +HasIndexIds returns a boolean if a field has been set. + +### GetIndexStatsMeasurements + +`func (o *MeasurementsIndexes) GetIndexStatsMeasurements() []Measurement` + +GetIndexStatsMeasurements returns the IndexStatsMeasurements field if non-nil, zero value otherwise. + +### GetIndexStatsMeasurementsOk + +`func (o *MeasurementsIndexes) GetIndexStatsMeasurementsOk() (*[]Measurement, bool)` + +GetIndexStatsMeasurementsOk returns a tuple with the IndexStatsMeasurements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndexStatsMeasurements + +`func (o *MeasurementsIndexes) SetIndexStatsMeasurements(v []Measurement)` + +SetIndexStatsMeasurements sets IndexStatsMeasurements field to given value. + +### HasIndexStatsMeasurements + +`func (o *MeasurementsIndexes) HasIndexStatsMeasurements() bool` + +HasIndexStatsMeasurements returns a boolean if a field has been set. + +### GetLinks + +`func (o *MeasurementsIndexes) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *MeasurementsIndexes) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *MeasurementsIndexes) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *MeasurementsIndexes) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetProcessId + +`func (o *MeasurementsIndexes) GetProcessId() string` + +GetProcessId returns the ProcessId field if non-nil, zero value otherwise. + +### GetProcessIdOk + +`func (o *MeasurementsIndexes) GetProcessIdOk() (*string, bool)` + +GetProcessIdOk returns a tuple with the ProcessId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessId + +`func (o *MeasurementsIndexes) SetProcessId(v string)` + +SetProcessId sets ProcessId field to given value. + +### HasProcessId + +`func (o *MeasurementsIndexes) HasProcessId() bool` + +HasProcessId returns a boolean if a field has been set. + +### GetStart + +`func (o *MeasurementsIndexes) GetStart() time.Time` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *MeasurementsIndexes) GetStartOk() (*time.Time, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *MeasurementsIndexes) SetStart(v time.Time)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *MeasurementsIndexes) HasStart() bool` + +HasStart returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MeasurementsNonIndex.md b/docs/docs/MeasurementsNonIndex.md new file mode 100644 index 00000000..8deb65b9 --- /dev/null +++ b/docs/docs/MeasurementsNonIndex.md @@ -0,0 +1,238 @@ +# MeasurementsNonIndex + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**End** | Pointer to **time.Time** | Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Granularity** | Pointer to **string** | Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`. | [optional] [readonly] +**HardwareMeasurements** | Pointer to [**[]Measurement**](Measurement.md) | List that contains the Atlas Search hardware measurements. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**ProcessId** | Pointer to **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**Start** | Pointer to **time.Time** | Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**StatusMeasurements** | Pointer to [**[]Measurement**](Measurement.md) | List that contains the Atlas Search status measurements. | [optional] [readonly] + +## Methods + +### NewMeasurementsNonIndex + +`func NewMeasurementsNonIndex() *MeasurementsNonIndex` + +NewMeasurementsNonIndex instantiates a new MeasurementsNonIndex object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMeasurementsNonIndexWithDefaults + +`func NewMeasurementsNonIndexWithDefaults() *MeasurementsNonIndex` + +NewMeasurementsNonIndexWithDefaults instantiates a new MeasurementsNonIndex object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnd + +`func (o *MeasurementsNonIndex) GetEnd() time.Time` + +GetEnd returns the End field if non-nil, zero value otherwise. + +### GetEndOk + +`func (o *MeasurementsNonIndex) GetEndOk() (*time.Time, bool)` + +GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnd + +`func (o *MeasurementsNonIndex) SetEnd(v time.Time)` + +SetEnd sets End field to given value. + +### HasEnd + +`func (o *MeasurementsNonIndex) HasEnd() bool` + +HasEnd returns a boolean if a field has been set. + +### GetGranularity + +`func (o *MeasurementsNonIndex) GetGranularity() string` + +GetGranularity returns the Granularity field if non-nil, zero value otherwise. + +### GetGranularityOk + +`func (o *MeasurementsNonIndex) GetGranularityOk() (*string, bool)` + +GetGranularityOk returns a tuple with the Granularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGranularity + +`func (o *MeasurementsNonIndex) SetGranularity(v string)` + +SetGranularity sets Granularity field to given value. + +### HasGranularity + +`func (o *MeasurementsNonIndex) HasGranularity() bool` + +HasGranularity returns a boolean if a field has been set. + +### GetGroupId + +`func (o *MeasurementsNonIndex) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *MeasurementsNonIndex) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *MeasurementsNonIndex) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *MeasurementsNonIndex) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHardwareMeasurements + +`func (o *MeasurementsNonIndex) GetHardwareMeasurements() []Measurement` + +GetHardwareMeasurements returns the HardwareMeasurements field if non-nil, zero value otherwise. + +### GetHardwareMeasurementsOk + +`func (o *MeasurementsNonIndex) GetHardwareMeasurementsOk() (*[]Measurement, bool)` + +GetHardwareMeasurementsOk returns a tuple with the HardwareMeasurements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHardwareMeasurements + +`func (o *MeasurementsNonIndex) SetHardwareMeasurements(v []Measurement)` + +SetHardwareMeasurements sets HardwareMeasurements field to given value. + +### HasHardwareMeasurements + +`func (o *MeasurementsNonIndex) HasHardwareMeasurements() bool` + +HasHardwareMeasurements returns a boolean if a field has been set. + +### GetLinks + +`func (o *MeasurementsNonIndex) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *MeasurementsNonIndex) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *MeasurementsNonIndex) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *MeasurementsNonIndex) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetProcessId + +`func (o *MeasurementsNonIndex) GetProcessId() string` + +GetProcessId returns the ProcessId field if non-nil, zero value otherwise. + +### GetProcessIdOk + +`func (o *MeasurementsNonIndex) GetProcessIdOk() (*string, bool)` + +GetProcessIdOk returns a tuple with the ProcessId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessId + +`func (o *MeasurementsNonIndex) SetProcessId(v string)` + +SetProcessId sets ProcessId field to given value. + +### HasProcessId + +`func (o *MeasurementsNonIndex) HasProcessId() bool` + +HasProcessId returns a boolean if a field has been set. + +### GetStart + +`func (o *MeasurementsNonIndex) GetStart() time.Time` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *MeasurementsNonIndex) GetStartOk() (*time.Time, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *MeasurementsNonIndex) SetStart(v time.Time)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *MeasurementsNonIndex) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetStatusMeasurements + +`func (o *MeasurementsNonIndex) GetStatusMeasurements() []Measurement` + +GetStatusMeasurements returns the StatusMeasurements field if non-nil, zero value otherwise. + +### GetStatusMeasurementsOk + +`func (o *MeasurementsNonIndex) GetStatusMeasurementsOk() (*[]Measurement, bool)` + +GetStatusMeasurementsOk returns a tuple with the StatusMeasurements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusMeasurements + +`func (o *MeasurementsNonIndex) SetStatusMeasurements(v []Measurement)` + +SetStatusMeasurements sets StatusMeasurements field to given value. + +### HasStatusMeasurements + +`func (o *MeasurementsNonIndex) HasStatusMeasurements() bool` + +HasStatusMeasurements returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MetricDataPoint.md b/docs/docs/MetricDataPoint.md new file mode 100644 index 00000000..4aad54ae --- /dev/null +++ b/docs/docs/MetricDataPoint.md @@ -0,0 +1,82 @@ +# MetricDataPoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Timestamp** | Pointer to **time.Time** | Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Value** | Pointer to **float32** | Value that comprises this data point. | [optional] [readonly] + +## Methods + +### NewMetricDataPoint + +`func NewMetricDataPoint() *MetricDataPoint` + +NewMetricDataPoint instantiates a new MetricDataPoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetricDataPointWithDefaults + +`func NewMetricDataPointWithDefaults() *MetricDataPoint` + +NewMetricDataPointWithDefaults instantiates a new MetricDataPoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTimestamp + +`func (o *MetricDataPoint) GetTimestamp() time.Time` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *MetricDataPoint) GetTimestampOk() (*time.Time, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *MetricDataPoint) SetTimestamp(v time.Time)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *MetricDataPoint) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetValue + +`func (o *MetricDataPoint) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MetricDataPoint) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MetricDataPoint) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MetricDataPoint) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MetricDataPointViewAtlas.md b/docs/docs/MetricDataPointViewAtlas.md new file mode 100644 index 00000000..baa5ab64 --- /dev/null +++ b/docs/docs/MetricDataPointViewAtlas.md @@ -0,0 +1,82 @@ +# MetricDataPointViewAtlas + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Timestamp** | Pointer to **time.Time** | Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Value** | Pointer to **float32** | Value that comprises this data point. | [optional] [readonly] + +## Methods + +### NewMetricDataPointViewAtlas + +`func NewMetricDataPointViewAtlas() *MetricDataPointViewAtlas` + +NewMetricDataPointViewAtlas instantiates a new MetricDataPointViewAtlas object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetricDataPointViewAtlasWithDefaults + +`func NewMetricDataPointViewAtlasWithDefaults() *MetricDataPointViewAtlas` + +NewMetricDataPointViewAtlasWithDefaults instantiates a new MetricDataPointViewAtlas object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTimestamp + +`func (o *MetricDataPointViewAtlas) GetTimestamp() time.Time` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *MetricDataPointViewAtlas) GetTimestampOk() (*time.Time, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *MetricDataPointViewAtlas) SetTimestamp(v time.Time)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *MetricDataPointViewAtlas) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetValue + +`func (o *MetricDataPointViewAtlas) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MetricDataPointViewAtlas) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MetricDataPointViewAtlas) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MetricDataPointViewAtlas) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MicrosoftTeams.md b/docs/docs/MicrosoftTeams.md new file mode 100644 index 00000000..bc77e0d8 --- /dev/null +++ b/docs/docs/MicrosoftTeams.md @@ -0,0 +1,77 @@ +# MicrosoftTeams + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MicrosoftTeamsWebhookUrl** | **string** | Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications. **NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted. | +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] + +## Methods + +### NewMicrosoftTeams + +`func NewMicrosoftTeams(microsoftTeamsWebhookUrl string, ) *MicrosoftTeams` + +NewMicrosoftTeams instantiates a new MicrosoftTeams object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMicrosoftTeamsWithDefaults + +`func NewMicrosoftTeamsWithDefaults() *MicrosoftTeams` + +NewMicrosoftTeamsWithDefaults instantiates a new MicrosoftTeams object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMicrosoftTeamsWebhookUrl + +`func (o *MicrosoftTeams) GetMicrosoftTeamsWebhookUrl() string` + +GetMicrosoftTeamsWebhookUrl returns the MicrosoftTeamsWebhookUrl field if non-nil, zero value otherwise. + +### GetMicrosoftTeamsWebhookUrlOk + +`func (o *MicrosoftTeams) GetMicrosoftTeamsWebhookUrlOk() (*string, bool)` + +GetMicrosoftTeamsWebhookUrlOk returns a tuple with the MicrosoftTeamsWebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMicrosoftTeamsWebhookUrl + +`func (o *MicrosoftTeams) SetMicrosoftTeamsWebhookUrl(v string)` + +SetMicrosoftTeamsWebhookUrl sets MicrosoftTeamsWebhookUrl field to given value. + + +### GetType + +`func (o *MicrosoftTeams) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MicrosoftTeams) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MicrosoftTeams) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MicrosoftTeams) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MicrosoftTeamsNotification.md b/docs/docs/MicrosoftTeamsNotification.md new file mode 100644 index 00000000..285f2a1e --- /dev/null +++ b/docs/docs/MicrosoftTeamsNotification.md @@ -0,0 +1,129 @@ +# MicrosoftTeamsNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**MicrosoftTeamsWebhookUrl** | Pointer to **string** | Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewMicrosoftTeamsNotification + +`func NewMicrosoftTeamsNotification(typeName string, ) *MicrosoftTeamsNotification` + +NewMicrosoftTeamsNotification instantiates a new MicrosoftTeamsNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMicrosoftTeamsNotificationWithDefaults + +`func NewMicrosoftTeamsNotificationWithDefaults() *MicrosoftTeamsNotification` + +NewMicrosoftTeamsNotificationWithDefaults instantiates a new MicrosoftTeamsNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *MicrosoftTeamsNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *MicrosoftTeamsNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *MicrosoftTeamsNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *MicrosoftTeamsNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *MicrosoftTeamsNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *MicrosoftTeamsNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *MicrosoftTeamsNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *MicrosoftTeamsNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetMicrosoftTeamsWebhookUrl + +`func (o *MicrosoftTeamsNotification) GetMicrosoftTeamsWebhookUrl() string` + +GetMicrosoftTeamsWebhookUrl returns the MicrosoftTeamsWebhookUrl field if non-nil, zero value otherwise. + +### GetMicrosoftTeamsWebhookUrlOk + +`func (o *MicrosoftTeamsNotification) GetMicrosoftTeamsWebhookUrlOk() (*string, bool)` + +GetMicrosoftTeamsWebhookUrlOk returns a tuple with the MicrosoftTeamsWebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMicrosoftTeamsWebhookUrl + +`func (o *MicrosoftTeamsNotification) SetMicrosoftTeamsWebhookUrl(v string)` + +SetMicrosoftTeamsWebhookUrl sets MicrosoftTeamsWebhookUrl field to given value. + +### HasMicrosoftTeamsWebhookUrl + +`func (o *MicrosoftTeamsNotification) HasMicrosoftTeamsWebhookUrl() bool` + +HasMicrosoftTeamsWebhookUrl returns a boolean if a field has been set. + +### GetTypeName + +`func (o *MicrosoftTeamsNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *MicrosoftTeamsNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *MicrosoftTeamsNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MongoDBAccessLogs.md b/docs/docs/MongoDBAccessLogs.md new file mode 100644 index 00000000..10cf0cf0 --- /dev/null +++ b/docs/docs/MongoDBAccessLogs.md @@ -0,0 +1,264 @@ +# MongoDBAccessLogs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthResult** | Pointer to **bool** | Flag that indicates whether the response should return successful authentication attempts only. | [optional] +**AuthSource** | Pointer to **string** | Database against which someone attempted to authenticate. | [optional] [readonly] +**FailureReason** | Pointer to **string** | Reason that the authentication failed. Null if authentication succeeded. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**Hostname** | Pointer to **string** | Human-readable label that identifies the hostname of the target node that received the authentication attempt. | [optional] [readonly] +**IpAddress** | Pointer to **string** | Internet Protocol address that attempted to authenticate with the database. | [optional] [readonly] +**LogLine** | Pointer to **string** | Text of the host log concerning the authentication attempt. | [optional] [readonly] +**Timestamp** | Pointer to **string** | Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**Username** | Pointer to **string** | Username used to authenticate against the database. | [optional] [readonly] + +## Methods + +### NewMongoDBAccessLogs + +`func NewMongoDBAccessLogs() *MongoDBAccessLogs` + +NewMongoDBAccessLogs instantiates a new MongoDBAccessLogs object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMongoDBAccessLogsWithDefaults + +`func NewMongoDBAccessLogsWithDefaults() *MongoDBAccessLogs` + +NewMongoDBAccessLogsWithDefaults instantiates a new MongoDBAccessLogs object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAuthResult + +`func (o *MongoDBAccessLogs) GetAuthResult() bool` + +GetAuthResult returns the AuthResult field if non-nil, zero value otherwise. + +### GetAuthResultOk + +`func (o *MongoDBAccessLogs) GetAuthResultOk() (*bool, bool)` + +GetAuthResultOk returns a tuple with the AuthResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthResult + +`func (o *MongoDBAccessLogs) SetAuthResult(v bool)` + +SetAuthResult sets AuthResult field to given value. + +### HasAuthResult + +`func (o *MongoDBAccessLogs) HasAuthResult() bool` + +HasAuthResult returns a boolean if a field has been set. + +### GetAuthSource + +`func (o *MongoDBAccessLogs) GetAuthSource() string` + +GetAuthSource returns the AuthSource field if non-nil, zero value otherwise. + +### GetAuthSourceOk + +`func (o *MongoDBAccessLogs) GetAuthSourceOk() (*string, bool)` + +GetAuthSourceOk returns a tuple with the AuthSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthSource + +`func (o *MongoDBAccessLogs) SetAuthSource(v string)` + +SetAuthSource sets AuthSource field to given value. + +### HasAuthSource + +`func (o *MongoDBAccessLogs) HasAuthSource() bool` + +HasAuthSource returns a boolean if a field has been set. + +### GetFailureReason + +`func (o *MongoDBAccessLogs) GetFailureReason() string` + +GetFailureReason returns the FailureReason field if non-nil, zero value otherwise. + +### GetFailureReasonOk + +`func (o *MongoDBAccessLogs) GetFailureReasonOk() (*string, bool)` + +GetFailureReasonOk returns a tuple with the FailureReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailureReason + +`func (o *MongoDBAccessLogs) SetFailureReason(v string)` + +SetFailureReason sets FailureReason field to given value. + +### HasFailureReason + +`func (o *MongoDBAccessLogs) HasFailureReason() bool` + +HasFailureReason returns a boolean if a field has been set. + +### GetGroupId + +`func (o *MongoDBAccessLogs) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *MongoDBAccessLogs) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *MongoDBAccessLogs) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *MongoDBAccessLogs) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostname + +`func (o *MongoDBAccessLogs) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *MongoDBAccessLogs) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *MongoDBAccessLogs) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *MongoDBAccessLogs) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *MongoDBAccessLogs) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *MongoDBAccessLogs) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *MongoDBAccessLogs) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *MongoDBAccessLogs) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetLogLine + +`func (o *MongoDBAccessLogs) GetLogLine() string` + +GetLogLine returns the LogLine field if non-nil, zero value otherwise. + +### GetLogLineOk + +`func (o *MongoDBAccessLogs) GetLogLineOk() (*string, bool)` + +GetLogLineOk returns a tuple with the LogLine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLine + +`func (o *MongoDBAccessLogs) SetLogLine(v string)` + +SetLogLine sets LogLine field to given value. + +### HasLogLine + +`func (o *MongoDBAccessLogs) HasLogLine() bool` + +HasLogLine returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *MongoDBAccessLogs) GetTimestamp() string` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *MongoDBAccessLogs) GetTimestampOk() (*string, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *MongoDBAccessLogs) SetTimestamp(v string)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *MongoDBAccessLogs) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetUsername + +`func (o *MongoDBAccessLogs) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *MongoDBAccessLogs) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *MongoDBAccessLogs) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *MongoDBAccessLogs) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MongoDBAccessLogsList.md b/docs/docs/MongoDBAccessLogsList.md new file mode 100644 index 00000000..709fd483 --- /dev/null +++ b/docs/docs/MongoDBAccessLogsList.md @@ -0,0 +1,56 @@ +# MongoDBAccessLogsList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessLogs** | Pointer to [**[]MongoDBAccessLogs**](MongoDBAccessLogs.md) | Authentication attempt, one per object, made against the cluster. | [optional] [readonly] + +## Methods + +### NewMongoDBAccessLogsList + +`func NewMongoDBAccessLogsList() *MongoDBAccessLogsList` + +NewMongoDBAccessLogsList instantiates a new MongoDBAccessLogsList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMongoDBAccessLogsListWithDefaults + +`func NewMongoDBAccessLogsListWithDefaults() *MongoDBAccessLogsList` + +NewMongoDBAccessLogsListWithDefaults instantiates a new MongoDBAccessLogsList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessLogs + +`func (o *MongoDBAccessLogsList) GetAccessLogs() []MongoDBAccessLogs` + +GetAccessLogs returns the AccessLogs field if non-nil, zero value otherwise. + +### GetAccessLogsOk + +`func (o *MongoDBAccessLogsList) GetAccessLogsOk() (*[]MongoDBAccessLogs, bool)` + +GetAccessLogsOk returns a tuple with the AccessLogs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessLogs + +`func (o *MongoDBAccessLogsList) SetAccessLogs(v []MongoDBAccessLogs)` + +SetAccessLogs sets AccessLogs field to given value. + +### HasAccessLogs + +`func (o *MongoDBAccessLogsList) HasAccessLogs() bool` + +HasAccessLogs returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MongoDBCloudUsersApi.md b/docs/docs/MongoDBCloudUsersApi.md new file mode 100644 index 00000000..cf149244 --- /dev/null +++ b/docs/docs/MongoDBCloudUsersApi.md @@ -0,0 +1,229 @@ +# \MongoDBCloudUsersApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateUser**](MongoDBCloudUsersApi.md#CreateUser) | **Post** /api/atlas/v2/users | Create One MongoDB Cloud User +[**GetUser**](MongoDBCloudUsersApi.md#GetUser) | **Get** /api/atlas/v2/users/{userId} | Return One MongoDB Cloud User using Its ID +[**GetUserByUsername**](MongoDBCloudUsersApi.md#GetUserByUsername) | **Get** /api/atlas/v2/users/byName/{userName} | Return One MongoDB Cloud User using Their Username + + + +## CreateUser + +> AppUser CreateUser(ctx).AppUser(appUser).Execute() + +Create One MongoDB Cloud User + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + appUser := *openapiclient.NewAppUser("Country_example", "EmailAddress_example", "FirstName_example", "LastName_example", "MobileNumber_example", "Password_example", "Username_example") // AppUser | + + resp, r, err := sdk.MongoDBCloudUsersApi.CreateUser(context.Background()).AppUser(appUser).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MongoDBCloudUsersApi.CreateUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateUser`: AppUser + fmt.Fprintf(os.Stdout, "Response from `MongoDBCloudUsersApi.CreateUser`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **appUser** | [**AppUser**](AppUser.md) | MongoDB Cloud user account to create. | + +### Return type + +[**AppUser**](AppUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetUser + +> AppUser GetUser(ctx, userId).Execute() + +Return One MongoDB Cloud User using Its ID + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + userId := "userId_example" // string | + + resp, r, err := sdk.MongoDBCloudUsersApi.GetUser(context.Background(), userId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MongoDBCloudUsersApi.GetUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetUser`: AppUser + fmt.Fprintf(os.Stdout, "Response from `MongoDBCloudUsersApi.GetUser`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**userId** | **string** | Unique 24-hexadecimal digit string that identifies this user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AppUser**](AppUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetUserByUsername + +> AppUser GetUserByUsername(ctx, userName).Execute() + +Return One MongoDB Cloud User using Their Username + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + userName := "userName_example" // string | + + resp, r, err := sdk.MongoDBCloudUsersApi.GetUserByUsername(context.Background(), userName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MongoDBCloudUsersApi.GetUserByUsername``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetUserByUsername`: AppUser + fmt.Fprintf(os.Stdout, "Response from `MongoDBCloudUsersApi.GetUserByUsername`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**userName** | **string** | Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUserByUsernameRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AppUser**](AppUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/MonitoringAndLogsApi.md b/docs/docs/MonitoringAndLogsApi.md new file mode 100644 index 00000000..76c9b738 --- /dev/null +++ b/docs/docs/MonitoringAndLogsApi.md @@ -0,0 +1,1187 @@ +# \MonitoringAndLogsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetAtlasProcess**](MonitoringAndLogsApi.md#GetAtlasProcess) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId} | Return One MongoDB Process by ID +[**GetDatabase**](MonitoringAndLogsApi.md#GetDatabase) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName} | Return One Database for a MongoDB Process +[**GetDatabaseMeasurements**](MonitoringAndLogsApi.md#GetDatabaseMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements | Return Measurements of One Database for One MongoDB Process +[**GetDiskMeasurements**](MonitoringAndLogsApi.md#GetDiskMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements | Return Measurements of One Disk for One MongoDB Process +[**GetHostLogs**](MonitoringAndLogsApi.md#GetHostLogs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz | Download Logs for One Multi-Cloud Cluster Host in One Project +[**GetHostMeasurements**](MonitoringAndLogsApi.md#GetHostMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements | Return Measurements for One MongoDB Process +[**GetIndexMetrics**](MonitoringAndLogsApi.md#GetIndexMetrics) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements | Return Atlas Search Metrics for One Index in One Specified Namespace +[**GetMeasurements**](MonitoringAndLogsApi.md#GetMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements | Return Atlas Search Hardware and Status Metrics +[**ListAtlasProcesses**](MonitoringAndLogsApi.md#ListAtlasProcesses) | **Get** /api/atlas/v2/groups/{groupId}/processes | Return All MongoDB Processes in One Project +[**ListDatabases**](MonitoringAndLogsApi.md#ListDatabases) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/databases | Return Available Databases for One MongoDB Process +[**ListDiskMeasurements**](MonitoringAndLogsApi.md#ListDiskMeasurements) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName} | Return Measurements of One Disk +[**ListDiskPartitions**](MonitoringAndLogsApi.md#ListDiskPartitions) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/disks | Return Available Disks for One MongoDB Process +[**ListIndexMetrics**](MonitoringAndLogsApi.md#ListIndexMetrics) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements | Return All Atlas Search Index Metrics for One Namespace +[**ListMetricTypes**](MonitoringAndLogsApi.md#ListMetricTypes) | **Get** /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics | Return All Atlas Search Metric Types for One Process + + + +## GetAtlasProcess + +> HostViewAtlas GetAtlasProcess(ctx, groupId, processId).Execute() + +Return One MongoDB Process by ID + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "mongodb.example.com:27017" // string | + + resp, r, err := sdk.MonitoringAndLogsApi.GetAtlasProcess(context.Background(), groupId, processId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetAtlasProcess``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetAtlasProcess`: HostViewAtlas + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetAtlasProcess`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAtlasProcessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**HostViewAtlas**](HostViewAtlas.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetDatabase + +> Database GetDatabase(ctx, groupId, databaseName, processId).Execute() + +Return One Database for a MongoDB Process + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + databaseName := "databaseName_example" // string | + processId := "mongodb.example.com:27017" // string | + + resp, r, err := sdk.MonitoringAndLogsApi.GetDatabase(context.Background(), groupId, databaseName, processId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetDatabase``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetDatabase`: Database + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetDatabase`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**databaseName** | **string** | Human-readable label that identifies the database that the specified MongoDB process serves. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDatabaseRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Database**](Database.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetDatabaseMeasurements + +> MeasurementsGeneralViewAtlas GetDatabaseMeasurements(ctx, groupId, databaseName, processId).M(m).Execute() + +Return Measurements of One Database for One MongoDB Process + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + databaseName := "databaseName_example" // string | + processId := "mongodb.example.com:27017" // string | + m := []string{"M_example"} // []string | (optional) + + resp, r, err := sdk.MonitoringAndLogsApi.GetDatabaseMeasurements(context.Background(), groupId, databaseName, processId).M(m).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetDatabaseMeasurements``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetDatabaseMeasurements`: MeasurementsGeneralViewAtlas + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetDatabaseMeasurements`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**databaseName** | **string** | Human-readable label that identifies the database that the specified MongoDB process serves. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDatabaseMeasurementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **m** | **[]string** | One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. | + +### Return type + +[**MeasurementsGeneralViewAtlas**](MeasurementsGeneralViewAtlas.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetDiskMeasurements + +> MeasurementsGeneralViewAtlas GetDiskMeasurements(ctx, groupId, partitionName, processId).M(m).Execute() + +Return Measurements of One Disk for One MongoDB Process + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + partitionName := "partitionName_example" // string | + processId := "mongodb.example.com:27017" // string | + m := []string{"M_example"} // []string | (optional) + + resp, r, err := sdk.MonitoringAndLogsApi.GetDiskMeasurements(context.Background(), groupId, partitionName, processId).M(m).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetDiskMeasurements``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetDiskMeasurements`: MeasurementsGeneralViewAtlas + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetDiskMeasurements`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**partitionName** | **string** | Human-readable label of the disk or partition to which the measurements apply. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDiskMeasurementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **m** | **[]string** | One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. | + +### Return type + +[**MeasurementsGeneralViewAtlas**](MeasurementsGeneralViewAtlas.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetHostLogs + +> *os.File GetHostLogs(ctx, groupId, hostName, logName).EndDate(endDate).StartDate(startDate).Execute() + +Download Logs for One Multi-Cloud Cluster Host in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + hostName := "hostName_example" // string | + logName := "logName_example" // string | + endDate := int64(789) // int64 | (optional) + startDate := int64(789) // int64 | (optional) + + resp, r, err := sdk.MonitoringAndLogsApi.GetHostLogs(context.Background(), groupId, hostName, logName).EndDate(endDate).StartDate(startDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetHostLogs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetHostLogs`: *os.File + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetHostLogs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**hostName** | **string** | Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. | +**logName** | **string** | Human-readable label of the log file that you want to return. You can return audit logs only if you enable Database Auditing for the specified project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHostLogsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **endDate** | **int64** | Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch. | + **startDate** | **int64** | Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch. | + +### Return type + +[***os.File**](*os.File.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+gzip, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetHostMeasurements + +> MeasurementsGeneralViewAtlas GetHostMeasurements(ctx, groupId, processId).M(m).Period(period).Execute() + +Return Measurements for One MongoDB Process + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "mongodb.example.com:27017" // string | + m := []string{"M_example"} // []string | (optional) + period := time.Now() // time.Time | (optional) + + resp, r, err := sdk.MonitoringAndLogsApi.GetHostMeasurements(context.Background(), groupId, processId).M(m).Period(period).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetHostMeasurements``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetHostMeasurements`: MeasurementsGeneralViewAtlas + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetHostMeasurements`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHostMeasurementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **m** | **[]string** | One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements. | + **period** | **time.Time** | Date and time that indicates how far in the past to query. You can't set this value with **start** and **end** in the same request. This parameter expresses its value in the ISO 8601 duration format in UTC | + +### Return type + +[**MeasurementsGeneralViewAtlas**](MeasurementsGeneralViewAtlas.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetIndexMetrics + +> MeasurementsIndexes GetIndexMetrics(ctx, processId, indexName, databaseName, collectionName, groupId).Granularity(granularity).Metrics(metrics).Period(period).Start(start).End(end).Execute() + +Return Atlas Search Metrics for One Index in One Specified Namespace + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + processId := "my.host.name.com:27017" // string | + indexName := "myindex" // string | + databaseName := "mydb" // string | + collectionName := "mycoll" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + granularity := "PT1M" // string | + metrics := []string{"Metrics_example"} // []string | + period := "PT10H" // string | (optional) + start := time.Now() // time.Time | (optional) + end := time.Now() // time.Time | (optional) + + resp, r, err := sdk.MonitoringAndLogsApi.GetIndexMetrics(context.Background(), processId, indexName, databaseName, collectionName, groupId).Granularity(granularity).Metrics(metrics).Period(period).Start(start).End(end).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetIndexMetrics``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetIndexMetrics`: MeasurementsIndexes + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetIndexMetrics`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**processId** | **string** | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. | +**indexName** | **string** | Human-readable label that identifies the index. | +**databaseName** | **string** | Human-readable label that identifies the database. | +**collectionName** | **string** | Human-readable label that identifies the collection. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIndexMetricsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + + + **granularity** | **string** | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. | + **metrics** | **[]string** | List that contains the measurements that MongoDB Atlas reports for the associated data series. | + **period** | **string** | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. | + **start** | **time.Time** | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. | + **end** | **time.Time** | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. | + +### Return type + +[**MeasurementsIndexes**](MeasurementsIndexes.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetMeasurements + +> MeasurementsNonIndex GetMeasurements(ctx, processId, groupId).Granularity(granularity).Metrics(metrics).Period(period).Start(start).End(end).Execute() + +Return Atlas Search Hardware and Status Metrics + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + processId := "my.host.name.com:27017" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + granularity := "PT1M" // string | + metrics := []string{"Metrics_example"} // []string | + period := "PT10H" // string | (optional) + start := time.Now() // time.Time | (optional) + end := time.Now() // time.Time | (optional) + + resp, r, err := sdk.MonitoringAndLogsApi.GetMeasurements(context.Background(), processId, groupId).Granularity(granularity).Metrics(metrics).Period(period).Start(start).End(end).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.GetMeasurements``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetMeasurements`: MeasurementsNonIndex + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.GetMeasurements`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**processId** | **string** | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMeasurementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **granularity** | **string** | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. | + **metrics** | **[]string** | List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series. | + **period** | **string** | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. | + **start** | **time.Time** | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. | + **end** | **time.Time** | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. | + +### Return type + +[**MeasurementsNonIndex**](MeasurementsNonIndex.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListAtlasProcesses + +> PaginatedHostViewAtlas ListAtlasProcesses(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All MongoDB Processes in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.MonitoringAndLogsApi.ListAtlasProcesses(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.ListAtlasProcesses``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListAtlasProcesses`: PaginatedHostViewAtlas + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.ListAtlasProcesses`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAtlasProcessesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedHostViewAtlas**](PaginatedHostViewAtlas.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListDatabases + +> PaginatedDatabase ListDatabases(ctx, groupId, processId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return Available Databases for One MongoDB Process + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "mongodb.example.com:27017" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.MonitoringAndLogsApi.ListDatabases(context.Background(), groupId, processId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.ListDatabases``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListDatabases`: PaginatedDatabase + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.ListDatabases`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDatabasesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedDatabase**](PaginatedDatabase.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListDiskMeasurements + +> DiskPartition ListDiskMeasurements(ctx, partitionName, groupId, processId).Execute() + +Return Measurements of One Disk + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + partitionName := "partitionName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "mongodb.example.com:27017" // string | + + resp, r, err := sdk.MonitoringAndLogsApi.ListDiskMeasurements(context.Background(), partitionName, groupId, processId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.ListDiskMeasurements``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListDiskMeasurements`: DiskPartition + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.ListDiskMeasurements`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**partitionName** | **string** | Human-readable label of the disk or partition to which the measurements apply. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDiskMeasurementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**DiskPartition**](DiskPartition.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListDiskPartitions + +> PaginatedDiskPartition ListDiskPartitions(ctx, groupId, processId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return Available Disks for One MongoDB Process + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "mongodb.example.com:27017" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.MonitoringAndLogsApi.ListDiskPartitions(context.Background(), groupId, processId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.ListDiskPartitions``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListDiskPartitions`: PaginatedDiskPartition + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.ListDiskPartitions`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDiskPartitionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedDiskPartition**](PaginatedDiskPartition.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListIndexMetrics + +> MeasurementsIndexes ListIndexMetrics(ctx, processId, databaseName, collectionName, groupId).Granularity(granularity).Metrics(metrics).Period(period).Start(start).End(end).Execute() + +Return All Atlas Search Index Metrics for One Namespace + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + processId := "my.host.name.com:27017" // string | + databaseName := "mydb" // string | + collectionName := "mycoll" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + granularity := "PT1M" // string | + metrics := []string{"Metrics_example"} // []string | + period := "PT10H" // string | (optional) + start := time.Now() // time.Time | (optional) + end := time.Now() // time.Time | (optional) + + resp, r, err := sdk.MonitoringAndLogsApi.ListIndexMetrics(context.Background(), processId, databaseName, collectionName, groupId).Granularity(granularity).Metrics(metrics).Period(period).Start(start).End(end).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.ListIndexMetrics``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListIndexMetrics`: MeasurementsIndexes + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.ListIndexMetrics`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**processId** | **string** | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. | +**databaseName** | **string** | Human-readable label that identifies the database. | +**collectionName** | **string** | Human-readable label that identifies the collection. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIndexMetricsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + + **granularity** | **string** | Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. | + **metrics** | **[]string** | List that contains the measurements that MongoDB Atlas reports for the associated data series. | + **period** | **string** | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**. | + **start** | **time.Time** | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. | + **end** | **time.Time** | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**. | + +### Return type + +[**MeasurementsIndexes**](MeasurementsIndexes.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListMetricTypes + +> FTSMetrics ListMetricTypes(ctx, processId, groupId).Execute() + +Return All Atlas Search Metric Types for One Process + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + processId := "my.host.name.com:27017" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.MonitoringAndLogsApi.ListMetricTypes(context.Background(), processId, groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MonitoringAndLogsApi.ListMetricTypes``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListMetricTypes`: FTSMetrics + fmt.Fprintf(os.Stdout, "Response from `MonitoringAndLogsApi.ListMetricTypes`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**processId** | **string** | Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListMetricTypesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**FTSMetrics**](FTSMetrics.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/MonthlySchedule.md b/docs/docs/MonthlySchedule.md new file mode 100644 index 00000000..bc3043fa --- /dev/null +++ b/docs/docs/MonthlySchedule.md @@ -0,0 +1,181 @@ +# MonthlySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DayOfMonth** | Pointer to **int** | Day of the month when the scheduled archive starts. | [optional] +**EndHour** | Pointer to **int** | Hour of the day when the scheduled window to run one online archive ends. | [optional] +**EndMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive ends. | [optional] +**StartHour** | Pointer to **int** | Hour of the day when the when the scheduled window to run one online archive starts. | [optional] +**StartMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive starts. | [optional] +**Type** | **string** | | + +## Methods + +### NewMonthlySchedule + +`func NewMonthlySchedule(type_ string, ) *MonthlySchedule` + +NewMonthlySchedule instantiates a new MonthlySchedule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMonthlyScheduleWithDefaults + +`func NewMonthlyScheduleWithDefaults() *MonthlySchedule` + +NewMonthlyScheduleWithDefaults instantiates a new MonthlySchedule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDayOfMonth + +`func (o *MonthlySchedule) GetDayOfMonth() int` + +GetDayOfMonth returns the DayOfMonth field if non-nil, zero value otherwise. + +### GetDayOfMonthOk + +`func (o *MonthlySchedule) GetDayOfMonthOk() (*int, bool)` + +GetDayOfMonthOk returns a tuple with the DayOfMonth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDayOfMonth + +`func (o *MonthlySchedule) SetDayOfMonth(v int)` + +SetDayOfMonth sets DayOfMonth field to given value. + +### HasDayOfMonth + +`func (o *MonthlySchedule) HasDayOfMonth() bool` + +HasDayOfMonth returns a boolean if a field has been set. + +### GetEndHour + +`func (o *MonthlySchedule) GetEndHour() int` + +GetEndHour returns the EndHour field if non-nil, zero value otherwise. + +### GetEndHourOk + +`func (o *MonthlySchedule) GetEndHourOk() (*int, bool)` + +GetEndHourOk returns a tuple with the EndHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndHour + +`func (o *MonthlySchedule) SetEndHour(v int)` + +SetEndHour sets EndHour field to given value. + +### HasEndHour + +`func (o *MonthlySchedule) HasEndHour() bool` + +HasEndHour returns a boolean if a field has been set. + +### GetEndMinute + +`func (o *MonthlySchedule) GetEndMinute() int` + +GetEndMinute returns the EndMinute field if non-nil, zero value otherwise. + +### GetEndMinuteOk + +`func (o *MonthlySchedule) GetEndMinuteOk() (*int, bool)` + +GetEndMinuteOk returns a tuple with the EndMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndMinute + +`func (o *MonthlySchedule) SetEndMinute(v int)` + +SetEndMinute sets EndMinute field to given value. + +### HasEndMinute + +`func (o *MonthlySchedule) HasEndMinute() bool` + +HasEndMinute returns a boolean if a field has been set. + +### GetStartHour + +`func (o *MonthlySchedule) GetStartHour() int` + +GetStartHour returns the StartHour field if non-nil, zero value otherwise. + +### GetStartHourOk + +`func (o *MonthlySchedule) GetStartHourOk() (*int, bool)` + +GetStartHourOk returns a tuple with the StartHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartHour + +`func (o *MonthlySchedule) SetStartHour(v int)` + +SetStartHour sets StartHour field to given value. + +### HasStartHour + +`func (o *MonthlySchedule) HasStartHour() bool` + +HasStartHour returns a boolean if a field has been set. + +### GetStartMinute + +`func (o *MonthlySchedule) GetStartMinute() int` + +GetStartMinute returns the StartMinute field if non-nil, zero value otherwise. + +### GetStartMinuteOk + +`func (o *MonthlySchedule) GetStartMinuteOk() (*int, bool)` + +GetStartMinuteOk returns a tuple with the StartMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartMinute + +`func (o *MonthlySchedule) SetStartMinute(v int)` + +SetStartMinute sets StartMinute field to given value. + +### HasStartMinute + +`func (o *MonthlySchedule) HasStartMinute() bool` + +HasStartMinute returns a boolean if a field has been set. + +### GetType + +`func (o *MonthlySchedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MonthlySchedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MonthlySchedule) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/MultiCloudClustersApi.md b/docs/docs/MultiCloudClustersApi.md new file mode 100644 index 00000000..108b7494 --- /dev/null +++ b/docs/docs/MultiCloudClustersApi.md @@ -0,0 +1,478 @@ +# \MultiCloudClustersApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateCluster**](MultiCloudClustersApi.md#CreateCluster) | **Post** /api/atlas/v2/groups/{groupId}/clusters | Create One Multi-Cloud Cluster from One Project +[**DeleteCluster**](MultiCloudClustersApi.md#DeleteCluster) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Remove One Multi-Cloud Cluster from One Project +[**GetCluster**](MultiCloudClustersApi.md#GetCluster) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Return One Multi-Cloud Cluster from One Project +[**ListClusters**](MultiCloudClustersApi.md#ListClusters) | **Get** /api/atlas/v2/groups/{groupId}/clusters | Return All Multi-Cloud Clusters from One Project +[**TestFailover**](MultiCloudClustersApi.md#TestFailover) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries | Test Failover for One Multi-Cloud Cluster +[**UpdateCluster**](MultiCloudClustersApi.md#UpdateCluster) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName} | Modify One Multi-Cloud Cluster from One Project + + + +## CreateCluster + +> ClusterDescriptionV15 CreateCluster(ctx, groupId).ClusterDescriptionV15(clusterDescriptionV15).Execute() + +Create One Multi-Cloud Cluster from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterDescriptionV15 := *openapiclient.NewClusterDescriptionV15() // ClusterDescriptionV15 | + + resp, r, err := sdk.MultiCloudClustersApi.CreateCluster(context.Background(), groupId).ClusterDescriptionV15(clusterDescriptionV15).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiCloudClustersApi.CreateCluster``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateCluster`: ClusterDescriptionV15 + fmt.Fprintf(os.Stdout, "Response from `MultiCloudClustersApi.CreateCluster`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **clusterDescriptionV15** | [**ClusterDescriptionV15**](ClusterDescriptionV15.md) | Cluster to create in the specific project. | + +### Return type + +[**ClusterDescriptionV15**](ClusterDescriptionV15.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-02-01+json +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteCluster + +> DeleteCluster(ctx, groupId, clusterName).RetainBackups(retainBackups).Execute() + +Remove One Multi-Cloud Cluster from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + retainBackups := true // bool | (optional) + + r, err := sdk.MultiCloudClustersApi.DeleteCluster(context.Background(), groupId, clusterName).RetainBackups(retainBackups).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiCloudClustersApi.DeleteCluster``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **retainBackups** | **bool** | Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. | + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetCluster + +> ClusterDescriptionV15 GetCluster(ctx, groupId, clusterName).Execute() + +Return One Multi-Cloud Cluster from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.MultiCloudClustersApi.GetCluster(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiCloudClustersApi.GetCluster``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetCluster`: ClusterDescriptionV15 + fmt.Fprintf(os.Stdout, "Response from `MultiCloudClustersApi.GetCluster`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies this advanced cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ClusterDescriptionV15**](ClusterDescriptionV15.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListClusters + +> PaginatedClusterDescriptionV15 ListClusters(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Multi-Cloud Clusters from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.MultiCloudClustersApi.ListClusters(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiCloudClustersApi.ListClusters``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListClusters`: PaginatedClusterDescriptionV15 + fmt.Fprintf(os.Stdout, "Response from `MultiCloudClustersApi.ListClusters`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListClustersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedClusterDescriptionV15**](PaginatedClusterDescriptionV15.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestFailover + +> TestFailover(ctx, groupId, clusterName).Execute() + +Test Failover for One Multi-Cloud Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + r, err := sdk.MultiCloudClustersApi.TestFailover(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiCloudClustersApi.TestFailover``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestFailoverRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateCluster + +> ClusterDescriptionV15 UpdateCluster(ctx, groupId, clusterName).ClusterDescriptionV15(clusterDescriptionV15).Execute() + +Modify One Multi-Cloud Cluster from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + clusterDescriptionV15 := *openapiclient.NewClusterDescriptionV15() // ClusterDescriptionV15 | + + resp, r, err := sdk.MultiCloudClustersApi.UpdateCluster(context.Background(), groupId, clusterName).ClusterDescriptionV15(clusterDescriptionV15).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiCloudClustersApi.UpdateCluster``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateCluster`: ClusterDescriptionV15 + fmt.Fprintf(os.Stdout, "Response from `MultiCloudClustersApi.UpdateCluster`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the advanced cluster to modify. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **clusterDescriptionV15** | [**ClusterDescriptionV15**](ClusterDescriptionV15.md) | Cluster to update in the specified project. | + +### Return type + +[**ClusterDescriptionV15**](ClusterDescriptionV15.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-02-01+json +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/NDSAuditTypeViewForNdsGroup.md b/docs/docs/NDSAuditTypeViewForNdsGroup.md new file mode 100644 index 00000000..5a8e4993 --- /dev/null +++ b/docs/docs/NDSAuditTypeViewForNdsGroup.md @@ -0,0 +1,337 @@ +# NDSAuditTypeViewForNdsGroup + +## Enum + + +* `CLUSTER_CREATED` (value: `"CLUSTER_CREATED"`) + +* `CLUSTER_READY` (value: `"CLUSTER_READY"`) + +* `CLUSTER_UPDATE_SUBMITTED` (value: `"CLUSTER_UPDATE_SUBMITTED"`) + +* `CLUSTER_UPDATE_SUBMITTED_INTERNAL` (value: `"CLUSTER_UPDATE_SUBMITTED_INTERNAL"`) + +* `CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED` (value: `"CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED"`) + +* `CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED` (value: `"CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED"`) + +* `CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED` (value: `"CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED"`) + +* `CLUSTER_AUTOMATICALLY_PAUSED` (value: `"CLUSTER_AUTOMATICALLY_PAUSED"`) + +* `CLUSTER_UPDATE_STARTED` (value: `"CLUSTER_UPDATE_STARTED"`) + +* `CLUSTER_UPDATE_COMPLETED` (value: `"CLUSTER_UPDATE_COMPLETED"`) + +* `CLUSTER_DELETE_SUBMITTED` (value: `"CLUSTER_DELETE_SUBMITTED"`) + +* `CLUSTER_DELETE_SUBMITTED_INTERNAL` (value: `"CLUSTER_DELETE_SUBMITTED_INTERNAL"`) + +* `CLUSTER_DELETED` (value: `"CLUSTER_DELETED"`) + +* `CLUSTER_IMPORT_STARTED` (value: `"CLUSTER_IMPORT_STARTED"`) + +* `CLUSTER_IMPORT_CANCELLED` (value: `"CLUSTER_IMPORT_CANCELLED"`) + +* `CLUSTER_IMPORT_EXPIRED` (value: `"CLUSTER_IMPORT_EXPIRED"`) + +* `CLUSTER_IMPORT_CUTOVER` (value: `"CLUSTER_IMPORT_CUTOVER"`) + +* `CLUSTER_IMPORT_RESTART_REQUESTED` (value: `"CLUSTER_IMPORT_RESTART_REQUESTED"`) + +* `PROJECT_LIVE_IMPORT_OVERRIDES_ADDED` (value: `"PROJECT_LIVE_IMPORT_OVERRIDES_ADDED"`) + +* `PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED` (value: `"PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED"`) + +* `PROJECT_LIVE_IMPORT_OVERRIDES_DELETED` (value: `"PROJECT_LIVE_IMPORT_OVERRIDES_DELETED"`) + +* `CLUSTER_OPLOG_RESIZED` (value: `"CLUSTER_OPLOG_RESIZED"`) + +* `CLUSTER_INSTANCE_RESTARTED` (value: `"CLUSTER_INSTANCE_RESTARTED"`) + +* `CLUSTER_INSTANCE_STOP_START` (value: `"CLUSTER_INSTANCE_STOP_START"`) + +* `CLUSTER_INSTANCE_RESYNC_REQUESTED` (value: `"CLUSTER_INSTANCE_RESYNC_REQUESTED"`) + +* `CLUSTER_INSTANCE_RESYNC_CLEARED` (value: `"CLUSTER_INSTANCE_RESYNC_CLEARED"`) + +* `CLUSTER_INSTANCE_UPDATE_REQUESTED` (value: `"CLUSTER_INSTANCE_UPDATE_REQUESTED"`) + +* `CLUSTER_INSTANCE_REPLACED` (value: `"CLUSTER_INSTANCE_REPLACED"`) + +* `CLUSTER_INSTANCE_REPLACE_CLEARED` (value: `"CLUSTER_INSTANCE_REPLACE_CLEARED"`) + +* `CLUSTER_INSTANCE_CONFIG_UPDATED` (value: `"CLUSTER_INSTANCE_CONFIG_UPDATED"`) + +* `CLUSTER_INSTANCE_SSL_ROTATED` (value: `"CLUSTER_INSTANCE_SSL_ROTATED"`) + +* `CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER` (value: `"CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER"`) + +* `CLUSTER_INSTANCE_SSL_REVOKED` (value: `"CLUSTER_INSTANCE_SSL_REVOKED"`) + +* `RELOAD_SSL_ON_PROCESSES` (value: `"RELOAD_SSL_ON_PROCESSES"`) + +* `CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED` (value: `"CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED"`) + +* `DATA_LAKE_QUERY_LOGS_DOWNLOADED` (value: `"DATA_LAKE_QUERY_LOGS_DOWNLOADED"`) + +* `FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED` (value: `"FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED"`) + +* `ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED` (value: `"ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED"`) + +* `MONGODB_LOGS_DOWNLOADED` (value: `"MONGODB_LOGS_DOWNLOADED"`) + +* `MONGOSQLD_LOGS_DOWNLOADED` (value: `"MONGOSQLD_LOGS_DOWNLOADED"`) + +* `MONGODB_USER_ADDED` (value: `"MONGODB_USER_ADDED"`) + +* `MONGODB_USER_DELETED` (value: `"MONGODB_USER_DELETED"`) + +* `MONGODB_USER_X509_CERT_CREATED` (value: `"MONGODB_USER_X509_CERT_CREATED"`) + +* `MONGODB_USER_X509_CERT_REVOKED` (value: `"MONGODB_USER_X509_CERT_REVOKED"`) + +* `MONGODB_USER_UPDATED` (value: `"MONGODB_USER_UPDATED"`) + +* `MONGODB_ROLE_ADDED` (value: `"MONGODB_ROLE_ADDED"`) + +* `MONGODB_ROLE_DELETED` (value: `"MONGODB_ROLE_DELETED"`) + +* `MONGODB_ROLE_UPDATED` (value: `"MONGODB_ROLE_UPDATED"`) + +* `NETWORK_PERMISSION_ENTRY_ADDED` (value: `"NETWORK_PERMISSION_ENTRY_ADDED"`) + +* `NETWORK_PERMISSION_ENTRY_REMOVED` (value: `"NETWORK_PERMISSION_ENTRY_REMOVED"`) + +* `NETWORK_PERMISSION_ENTRY_UPDATED` (value: `"NETWORK_PERMISSION_ENTRY_UPDATED"`) + +* `PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED` (value: `"PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED"`) + +* `PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED` (value: `"PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED"`) + +* `PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED` (value: `"PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED"`) + +* `PLAN_STARTED` (value: `"PLAN_STARTED"`) + +* `PLAN_COMPLETED` (value: `"PLAN_COMPLETED"`) + +* `PLAN_ABANDONED` (value: `"PLAN_ABANDONED"`) + +* `PLAN_FAILURE_COUNT_RESET` (value: `"PLAN_FAILURE_COUNT_RESET"`) + +* `PLAN_ASAP_REQUESTED` (value: `"PLAN_ASAP_REQUESTED"`) + +* `MOVE_SKIPPED` (value: `"MOVE_SKIPPED"`) + +* `PROXY_RESTARTED` (value: `"PROXY_RESTARTED"`) + +* `PROXY_PANICKED` (value: `"PROXY_PANICKED"`) + +* `MAINTENANCE_WINDOW_ADDED` (value: `"MAINTENANCE_WINDOW_ADDED"`) + +* `ATLAS_MAINTENANCE_WINDOW_ADDED` (value: `"ATLAS_MAINTENANCE_WINDOW_ADDED"`) + +* `MAINTENANCE_WINDOW_MODIFIED` (value: `"MAINTENANCE_WINDOW_MODIFIED"`) + +* `ATLAS_MAINTENANCE_WINDOW_MODIFIED` (value: `"ATLAS_MAINTENANCE_WINDOW_MODIFIED"`) + +* `MAINTENANCE_WINDOW_REMOVED` (value: `"MAINTENANCE_WINDOW_REMOVED"`) + +* `ATLAS_MAINTENANCE_WINDOW_REMOVED` (value: `"ATLAS_MAINTENANCE_WINDOW_REMOVED"`) + +* `MAINTENANCE_START_ASAP` (value: `"MAINTENANCE_START_ASAP"`) + +* `ATLAS_MAINTENANCE_START_ASAP` (value: `"ATLAS_MAINTENANCE_START_ASAP"`) + +* `MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW` (value: `"MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW"`) + +* `ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW` (value: `"ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW"`) + +* `MAINTENANCE_DEFERRED` (value: `"MAINTENANCE_DEFERRED"`) + +* `ATLAS_MAINTENANCE_DEFERRED` (value: `"ATLAS_MAINTENANCE_DEFERRED"`) + +* `MAINTENANCE_AUTO_DEFER_ENABLED` (value: `"MAINTENANCE_AUTO_DEFER_ENABLED"`) + +* `ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED` (value: `"ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED"`) + +* `MAINTENANCE_AUTO_DEFER_DISABLED` (value: `"MAINTENANCE_AUTO_DEFER_DISABLED"`) + +* `ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED` (value: `"ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED"`) + +* `SCHEDULED_MAINTENANCE` (value: `"SCHEDULED_MAINTENANCE"`) + +* `PROJECT_SCHEDULED_MAINTENANCE` (value: `"PROJECT_SCHEDULED_MAINTENANCE"`) + +* `PROJECT_LIMIT_UPDATED` (value: `"PROJECT_LIMIT_UPDATED"`) + +* `PROJECT_OPERATIONAL_LIMIT_UPDATED` (value: `"PROJECT_OPERATIONAL_LIMIT_UPDATED"`) + +* `PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED` (value: `"PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED"`) + +* `OS_MAINTENANCE` (value: `"OS_MAINTENANCE"`) + +* `OS_MAINTENANCE_RESTART` (value: `"OS_MAINTENANCE_RESTART"`) + +* `OS_MAINTENANCE_CERTIFICATE_ROTATION_RESTART` (value: `"OS_MAINTENANCE_CERTIFICATE_ROTATION_RESTART"`) + +* `OS_MAINTENANCE_REPLACEMENT` (value: `"OS_MAINTENANCE_REPLACEMENT"`) + +* `FREE_UPGRADE_STARTED` (value: `"FREE_UPGRADE_STARTED"`) + +* `TEST_FAILOVER_REQUESTED` (value: `"TEST_FAILOVER_REQUESTED"`) + +* `USER_SECURITY_SETTINGS_UPDATED` (value: `"USER_SECURITY_SETTINGS_UPDATED"`) + +* `AUDIT_LOG_CONFIGURATION_UPDATED` (value: `"AUDIT_LOG_CONFIGURATION_UPDATED"`) + +* `ENCRYPTION_AT_REST_CONFIGURATION_UPDATED` (value: `"ENCRYPTION_AT_REST_CONFIGURATION_UPDATED"`) + +* `ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED` (value: `"ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED"`) + +* `SET_IMAGE_OVERRIDES` (value: `"SET_IMAGE_OVERRIDES"`) + +* `NDS_SET_IMAGE_OVERRIDES` (value: `"NDS_SET_IMAGE_OVERRIDES"`) + +* `SET_CHEF_TARBALL_URI` (value: `"SET_CHEF_TARBALL_URI"`) + +* `NDS_SET_CHEF_TARBALL_URI` (value: `"NDS_SET_CHEF_TARBALL_URI"`) + +* `RESTRICTED_EMPLOYEE_ACCESS_BYPASS` (value: `"RESTRICTED_EMPLOYEE_ACCESS_BYPASS"`) + +* `REVOKED_EMPLOYEE_ACCESS_BYPASS` (value: `"REVOKED_EMPLOYEE_ACCESS_BYPASS"`) + +* `DEVICE_SYNC_DEBUG_ACCESS_GRANTED` (value: `"DEVICE_SYNC_DEBUG_ACCESS_GRANTED"`) + +* `DEVICE_SYNC_DEBUG_ACCESS_REVOKED` (value: `"DEVICE_SYNC_DEBUG_ACCESS_REVOKED"`) + +* `DEVICE_SYNC_DEBUG_X509_CERT_CREATED` (value: `"DEVICE_SYNC_DEBUG_X509_CERT_CREATED"`) + +* `QUERY_ENGINE_TENANT_CREATED` (value: `"QUERY_ENGINE_TENANT_CREATED"`) + +* `QUERY_ENGINE_TENANT_UPDATED` (value: `"QUERY_ENGINE_TENANT_UPDATED"`) + +* `QUERY_ENGINE_TENANT_REMOVED` (value: `"QUERY_ENGINE_TENANT_REMOVED"`) + +* `FEDERATED_DATABASE_CREATED` (value: `"FEDERATED_DATABASE_CREATED"`) + +* `FEDERATED_DATABASE_UPDATED` (value: `"FEDERATED_DATABASE_UPDATED"`) + +* `FEDERATED_DATABASE_REMOVED` (value: `"FEDERATED_DATABASE_REMOVED"`) + +* `TENANT_CLUSTER_UPGRADE_FROM_MTM` (value: `"TENANT_CLUSTER_UPGRADE_FROM_MTM"`) + +* `TENANT_SNAPSHOT_FAILED` (value: `"TENANT_SNAPSHOT_FAILED"`) + +* `TENANT_RESTORE_FAILED` (value: `"TENANT_RESTORE_FAILED"`) + +* `SAMPLE_DATASET_LOAD_REQUESTED` (value: `"SAMPLE_DATASET_LOAD_REQUESTED"`) + +* `CUSTOMER_X509_CRL_UPDATED` (value: `"CUSTOMER_X509_CRL_UPDATED"`) + +* `CONTAINER_SUBNETS_UPDATE_REQUESTED` (value: `"CONTAINER_SUBNETS_UPDATE_REQUESTED"`) + +* `CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED` (value: `"CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED"`) + +* `ONLINE_ARCHIVE_CREATED` (value: `"ONLINE_ARCHIVE_CREATED"`) + +* `ONLINE_ARCHIVE_DELETED` (value: `"ONLINE_ARCHIVE_DELETED"`) + +* `ONLINE_ARCHIVE_UPDATED` (value: `"ONLINE_ARCHIVE_UPDATED"`) + +* `ONLINE_ARCHIVE_PAUSE_REQUESTED` (value: `"ONLINE_ARCHIVE_PAUSE_REQUESTED"`) + +* `ONLINE_ARCHIVE_PAUSED` (value: `"ONLINE_ARCHIVE_PAUSED"`) + +* `ONLINE_ARCHIVE_ACTIVE` (value: `"ONLINE_ARCHIVE_ACTIVE"`) + +* `ONLINE_ARCHIVE_ORPHANED` (value: `"ONLINE_ARCHIVE_ORPHANED"`) + +* `ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED` (value: `"ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED"`) + +* `ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED` (value: `"ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED"`) + +* `ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED` (value: `"ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED"`) + +* `CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED` (value: `"CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED"`) + +* `CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED` (value: `"CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED"`) + +* `CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED` (value: `"CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED"`) + +* `CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED` (value: `"CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED"`) + +* `CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED` (value: `"CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED"`) + +* `CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED` (value: `"CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED"`) + +* `PENDING_INDEXES_DELETED` (value: `"PENDING_INDEXES_DELETED"`) + +* `PENDING_INDEXES_CANCELED` (value: `"PENDING_INDEXES_CANCELED"`) + +* `PROCESS_RESTART_REQUESTED` (value: `"PROCESS_RESTART_REQUESTED"`) + +* `AUTO_HEALING_ACTION` (value: `"AUTO_HEALING_ACTION"`) + +* `EXTRA_MAINTENANCE_DEFERRAL_GRANTED` (value: `"EXTRA_MAINTENANCE_DEFERRAL_GRANTED"`) + +* `ADMIN_NOTE_UPDATED` (value: `"ADMIN_NOTE_UPDATED"`) + +* `GROUP_AUTOMATION_CONFIG_PUBLISHED` (value: `"GROUP_AUTOMATION_CONFIG_PUBLISHED"`) + +* `CLUSTER_AUTOMATION_CONFIG_PUBLISHED` (value: `"CLUSTER_AUTOMATION_CONFIG_PUBLISHED"`) + +* `CLUSTER_LINKED_TO_VERCEL` (value: `"CLUSTER_LINKED_TO_VERCEL"`) + +* `CLUSTER_UNLINKED_FROM_VERCEL` (value: `"CLUSTER_UNLINKED_FROM_VERCEL"`) + +* `INGESTION_PIPELINE_DELETED` (value: `"INGESTION_PIPELINE_DELETED"`) + +* `INGESTION_PIPELINE_DESTROYED` (value: `"INGESTION_PIPELINE_DESTROYED"`) + +* `INGESTION_PIPELINE_CREATED` (value: `"INGESTION_PIPELINE_CREATED"`) + +* `INGESTION_PIPELINE_UPDATED` (value: `"INGESTION_PIPELINE_UPDATED"`) + +* `OS_TUNED_FILE_OVERRIDES` (value: `"OS_TUNED_FILE_OVERRIDES"`) + +* `OS_TUNE_FILE_OVERRIDES` (value: `"OS_TUNE_FILE_OVERRIDES"`) + +* `CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED` (value: `"CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED"`) + +* `CLUSTER_FORCE_PLANNED` (value: `"CLUSTER_FORCE_PLANNED"`) + +* `DATA_PROCESSING_REGION_UPDATED` (value: `"DATA_PROCESSING_REGION_UPDATED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED"`) + +* `CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE` (value: `"CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE"`) + +* `UIS_PANICKED` (value: `"UIS_PANICKED"`) + +* `TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL` (value: `"TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL"`) + +* `TENANT_UPGRADE_TO_SERVERLESS_FAILED` (value: `"TENANT_UPGRADE_TO_SERVERLESS_FAILED"`) + +* `CLUSTER_FORCE_RECONFIG_REQUESTED` (value: `"CLUSTER_FORCE_RECONFIG_REQUESTED"`) + +* `PROJECT_BYPASSED_MAINTENANCE` (value: `"PROJECT_BYPASSED_MAINTENANCE"`) + +* `DATA_FEDERATION_QUERY_LIMIT_CONFIGURED` (value: `"DATA_FEDERATION_QUERY_LIMIT_CONFIGURED"`) + +* `DATA_FEDERATION_QUERY_LIMIT_DELETED` (value: `"DATA_FEDERATION_QUERY_LIMIT_DELETED"`) + +* `DATA_API_SETUP_FOR_VERCEL` (value: `"DATA_API_SETUP_FOR_VERCEL"`) + +* `ADMIN_CLUSTER_LOCK_UPDATED` (value: `"ADMIN_CLUSTER_LOCK_UPDATED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSAuditTypeViewForOrg.md b/docs/docs/NDSAuditTypeViewForOrg.md new file mode 100644 index 00000000..51524a16 --- /dev/null +++ b/docs/docs/NDSAuditTypeViewForOrg.md @@ -0,0 +1,11 @@ +# NDSAuditTypeViewForOrg + +## Enum + + +* `ORG_LIMIT_UPDATED` (value: `"ORG_LIMIT_UPDATED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSAuditViewForNdsGroup.md b/docs/docs/NDSAuditViewForNdsGroup.md new file mode 100644 index 00000000..9b95f0d6 --- /dev/null +++ b/docs/docs/NDSAuditViewForNdsGroup.md @@ -0,0 +1,379 @@ +# NDSAuditViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**NDSAuditTypeViewForNdsGroup**](NDSAuditTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] +**WhitelistEntry** | Pointer to **string** | Entry in the list of source host addresses that the API key accepts and this event targets. | [optional] [readonly] + +## Methods + +### NewNDSAuditViewForNdsGroup + +`func NewNDSAuditViewForNdsGroup(created time.Time, eventTypeName NDSAuditTypeViewForNdsGroup, id string, ) *NDSAuditViewForNdsGroup` + +NewNDSAuditViewForNdsGroup instantiates a new NDSAuditViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSAuditViewForNdsGroupWithDefaults + +`func NewNDSAuditViewForNdsGroupWithDefaults() *NDSAuditViewForNdsGroup` + +NewNDSAuditViewForNdsGroupWithDefaults instantiates a new NDSAuditViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *NDSAuditViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *NDSAuditViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *NDSAuditViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *NDSAuditViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NDSAuditViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NDSAuditViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NDSAuditViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *NDSAuditViewForNdsGroup) GetEventTypeName() NDSAuditTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NDSAuditViewForNdsGroup) GetEventTypeNameOk() (*NDSAuditTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NDSAuditViewForNdsGroup) SetEventTypeName(v NDSAuditTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NDSAuditViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NDSAuditViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NDSAuditViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NDSAuditViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *NDSAuditViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NDSAuditViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NDSAuditViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *NDSAuditViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *NDSAuditViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *NDSAuditViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *NDSAuditViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSAuditViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSAuditViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSAuditViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSAuditViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *NDSAuditViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *NDSAuditViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *NDSAuditViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *NDSAuditViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *NDSAuditViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *NDSAuditViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *NDSAuditViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *NDSAuditViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *NDSAuditViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *NDSAuditViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *NDSAuditViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *NDSAuditViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *NDSAuditViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *NDSAuditViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *NDSAuditViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *NDSAuditViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *NDSAuditViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *NDSAuditViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *NDSAuditViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *NDSAuditViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *NDSAuditViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *NDSAuditViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *NDSAuditViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *NDSAuditViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetWhitelistEntry + +`func (o *NDSAuditViewForNdsGroup) GetWhitelistEntry() string` + +GetWhitelistEntry returns the WhitelistEntry field if non-nil, zero value otherwise. + +### GetWhitelistEntryOk + +`func (o *NDSAuditViewForNdsGroup) GetWhitelistEntryOk() (*string, bool)` + +GetWhitelistEntryOk returns a tuple with the WhitelistEntry field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWhitelistEntry + +`func (o *NDSAuditViewForNdsGroup) SetWhitelistEntry(v string)` + +SetWhitelistEntry sets WhitelistEntry field to given value. + +### HasWhitelistEntry + +`func (o *NDSAuditViewForNdsGroup) HasWhitelistEntry() bool` + +HasWhitelistEntry returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSAuditViewForOrg.md b/docs/docs/NDSAuditViewForOrg.md new file mode 100644 index 00000000..c706283f --- /dev/null +++ b/docs/docs/NDSAuditViewForOrg.md @@ -0,0 +1,379 @@ +# NDSAuditViewForOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**NDSAuditTypeViewForOrg**](NDSAuditTypeViewForOrg.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] +**WhitelistEntry** | Pointer to **string** | Entry in the list of source host addresses that the API key accepts and this event targets. | [optional] [readonly] + +## Methods + +### NewNDSAuditViewForOrg + +`func NewNDSAuditViewForOrg(created time.Time, eventTypeName NDSAuditTypeViewForOrg, id string, ) *NDSAuditViewForOrg` + +NewNDSAuditViewForOrg instantiates a new NDSAuditViewForOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSAuditViewForOrgWithDefaults + +`func NewNDSAuditViewForOrgWithDefaults() *NDSAuditViewForOrg` + +NewNDSAuditViewForOrgWithDefaults instantiates a new NDSAuditViewForOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *NDSAuditViewForOrg) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *NDSAuditViewForOrg) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *NDSAuditViewForOrg) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *NDSAuditViewForOrg) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NDSAuditViewForOrg) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NDSAuditViewForOrg) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NDSAuditViewForOrg) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *NDSAuditViewForOrg) GetEventTypeName() NDSAuditTypeViewForOrg` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NDSAuditViewForOrg) GetEventTypeNameOk() (*NDSAuditTypeViewForOrg, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NDSAuditViewForOrg) SetEventTypeName(v NDSAuditTypeViewForOrg)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NDSAuditViewForOrg) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NDSAuditViewForOrg) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NDSAuditViewForOrg) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NDSAuditViewForOrg) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *NDSAuditViewForOrg) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NDSAuditViewForOrg) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NDSAuditViewForOrg) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *NDSAuditViewForOrg) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *NDSAuditViewForOrg) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *NDSAuditViewForOrg) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *NDSAuditViewForOrg) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSAuditViewForOrg) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSAuditViewForOrg) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSAuditViewForOrg) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSAuditViewForOrg) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *NDSAuditViewForOrg) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *NDSAuditViewForOrg) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *NDSAuditViewForOrg) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *NDSAuditViewForOrg) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *NDSAuditViewForOrg) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *NDSAuditViewForOrg) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *NDSAuditViewForOrg) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *NDSAuditViewForOrg) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *NDSAuditViewForOrg) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *NDSAuditViewForOrg) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *NDSAuditViewForOrg) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *NDSAuditViewForOrg) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *NDSAuditViewForOrg) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *NDSAuditViewForOrg) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *NDSAuditViewForOrg) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *NDSAuditViewForOrg) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *NDSAuditViewForOrg) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *NDSAuditViewForOrg) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *NDSAuditViewForOrg) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *NDSAuditViewForOrg) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *NDSAuditViewForOrg) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *NDSAuditViewForOrg) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *NDSAuditViewForOrg) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *NDSAuditViewForOrg) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetWhitelistEntry + +`func (o *NDSAuditViewForOrg) GetWhitelistEntry() string` + +GetWhitelistEntry returns the WhitelistEntry field if non-nil, zero value otherwise. + +### GetWhitelistEntryOk + +`func (o *NDSAuditViewForOrg) GetWhitelistEntryOk() (*string, bool)` + +GetWhitelistEntryOk returns a tuple with the WhitelistEntry field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWhitelistEntry + +`func (o *NDSAuditViewForOrg) SetWhitelistEntry(v string)` + +SetWhitelistEntry sets WhitelistEntry field to given value. + +### HasWhitelistEntry + +`func (o *NDSAuditViewForOrg) HasWhitelistEntry() bool` + +HasWhitelistEntry returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSAutoScalingAuditTypeViewForNdsGroup.md b/docs/docs/NDSAutoScalingAuditTypeViewForNdsGroup.md new file mode 100644 index 00000000..d76e2e08 --- /dev/null +++ b/docs/docs/NDSAutoScalingAuditTypeViewForNdsGroup.md @@ -0,0 +1,17 @@ +# NDSAutoScalingAuditTypeViewForNdsGroup + +## Enum + + +* `COMPUTE_AUTO_SCALE_INITIATED` (value: `"COMPUTE_AUTO_SCALE_INITIATED"`) + +* `DISK_AUTO_SCALE_INITIATED` (value: `"DISK_AUTO_SCALE_INITIATED"`) + +* `COMPUTE_AUTO_SCALE_INITIATED_BASE` (value: `"COMPUTE_AUTO_SCALE_INITIATED_BASE"`) + +* `COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS` (value: `"COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSAutoScalingAuditViewForNdsGroup.md b/docs/docs/NDSAutoScalingAuditViewForNdsGroup.md new file mode 100644 index 00000000..1e517619 --- /dev/null +++ b/docs/docs/NDSAutoScalingAuditViewForNdsGroup.md @@ -0,0 +1,353 @@ +# NDSAutoScalingAuditViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**NDSAutoScalingAuditTypeViewForNdsGroup**](NDSAutoScalingAuditTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewNDSAutoScalingAuditViewForNdsGroup + +`func NewNDSAutoScalingAuditViewForNdsGroup(created time.Time, eventTypeName NDSAutoScalingAuditTypeViewForNdsGroup, id string, ) *NDSAutoScalingAuditViewForNdsGroup` + +NewNDSAutoScalingAuditViewForNdsGroup instantiates a new NDSAutoScalingAuditViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSAutoScalingAuditViewForNdsGroupWithDefaults + +`func NewNDSAutoScalingAuditViewForNdsGroupWithDefaults() *NDSAutoScalingAuditViewForNdsGroup` + +NewNDSAutoScalingAuditViewForNdsGroupWithDefaults instantiates a new NDSAutoScalingAuditViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetEventTypeName() NDSAutoScalingAuditTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetEventTypeNameOk() (*NDSAutoScalingAuditTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetEventTypeName(v NDSAutoScalingAuditTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *NDSAutoScalingAuditViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *NDSAutoScalingAuditViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *NDSAutoScalingAuditViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSLDAP.md b/docs/docs/NDSLDAP.md new file mode 100644 index 00000000..ea473d66 --- /dev/null +++ b/docs/docs/NDSLDAP.md @@ -0,0 +1,290 @@ +# NDSLDAP + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthenticationEnabled** | Pointer to **bool** | Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host. | [optional] +**AuthorizationEnabled** | Pointer to **bool** | Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host. | [optional] +**AuthzQueryTemplate** | Pointer to **string** | Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://tools.ietf.org/search/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516). | [optional] [default to "{USER}?memberOf?base"] +**BindPassword** | Pointer to **string** | Password that MongoDB Cloud uses to authenticate the **bindUsername**. | [optional] +**BindUsername** | Pointer to **string** | Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253. | [optional] +**CaCertificate** | Pointer to **string** | Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`. | [optional] +**Hostname** | Pointer to **string** | Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Port** | Pointer to **int** | Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. | [optional] [default to 636] +**UserToDNMapping** | Pointer to [**[]NDSUserToDNMapping**](NDSUserToDNMapping.md) | User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN. | [optional] + +## Methods + +### NewNDSLDAP + +`func NewNDSLDAP() *NDSLDAP` + +NewNDSLDAP instantiates a new NDSLDAP object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSLDAPWithDefaults + +`func NewNDSLDAPWithDefaults() *NDSLDAP` + +NewNDSLDAPWithDefaults instantiates a new NDSLDAP object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAuthenticationEnabled + +`func (o *NDSLDAP) GetAuthenticationEnabled() bool` + +GetAuthenticationEnabled returns the AuthenticationEnabled field if non-nil, zero value otherwise. + +### GetAuthenticationEnabledOk + +`func (o *NDSLDAP) GetAuthenticationEnabledOk() (*bool, bool)` + +GetAuthenticationEnabledOk returns a tuple with the AuthenticationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthenticationEnabled + +`func (o *NDSLDAP) SetAuthenticationEnabled(v bool)` + +SetAuthenticationEnabled sets AuthenticationEnabled field to given value. + +### HasAuthenticationEnabled + +`func (o *NDSLDAP) HasAuthenticationEnabled() bool` + +HasAuthenticationEnabled returns a boolean if a field has been set. + +### GetAuthorizationEnabled + +`func (o *NDSLDAP) GetAuthorizationEnabled() bool` + +GetAuthorizationEnabled returns the AuthorizationEnabled field if non-nil, zero value otherwise. + +### GetAuthorizationEnabledOk + +`func (o *NDSLDAP) GetAuthorizationEnabledOk() (*bool, bool)` + +GetAuthorizationEnabledOk returns a tuple with the AuthorizationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthorizationEnabled + +`func (o *NDSLDAP) SetAuthorizationEnabled(v bool)` + +SetAuthorizationEnabled sets AuthorizationEnabled field to given value. + +### HasAuthorizationEnabled + +`func (o *NDSLDAP) HasAuthorizationEnabled() bool` + +HasAuthorizationEnabled returns a boolean if a field has been set. + +### GetAuthzQueryTemplate + +`func (o *NDSLDAP) GetAuthzQueryTemplate() string` + +GetAuthzQueryTemplate returns the AuthzQueryTemplate field if non-nil, zero value otherwise. + +### GetAuthzQueryTemplateOk + +`func (o *NDSLDAP) GetAuthzQueryTemplateOk() (*string, bool)` + +GetAuthzQueryTemplateOk returns a tuple with the AuthzQueryTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthzQueryTemplate + +`func (o *NDSLDAP) SetAuthzQueryTemplate(v string)` + +SetAuthzQueryTemplate sets AuthzQueryTemplate field to given value. + +### HasAuthzQueryTemplate + +`func (o *NDSLDAP) HasAuthzQueryTemplate() bool` + +HasAuthzQueryTemplate returns a boolean if a field has been set. + +### GetBindPassword + +`func (o *NDSLDAP) GetBindPassword() string` + +GetBindPassword returns the BindPassword field if non-nil, zero value otherwise. + +### GetBindPasswordOk + +`func (o *NDSLDAP) GetBindPasswordOk() (*string, bool)` + +GetBindPasswordOk returns a tuple with the BindPassword field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBindPassword + +`func (o *NDSLDAP) SetBindPassword(v string)` + +SetBindPassword sets BindPassword field to given value. + +### HasBindPassword + +`func (o *NDSLDAP) HasBindPassword() bool` + +HasBindPassword returns a boolean if a field has been set. + +### GetBindUsername + +`func (o *NDSLDAP) GetBindUsername() string` + +GetBindUsername returns the BindUsername field if non-nil, zero value otherwise. + +### GetBindUsernameOk + +`func (o *NDSLDAP) GetBindUsernameOk() (*string, bool)` + +GetBindUsernameOk returns a tuple with the BindUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBindUsername + +`func (o *NDSLDAP) SetBindUsername(v string)` + +SetBindUsername sets BindUsername field to given value. + +### HasBindUsername + +`func (o *NDSLDAP) HasBindUsername() bool` + +HasBindUsername returns a boolean if a field has been set. + +### GetCaCertificate + +`func (o *NDSLDAP) GetCaCertificate() string` + +GetCaCertificate returns the CaCertificate field if non-nil, zero value otherwise. + +### GetCaCertificateOk + +`func (o *NDSLDAP) GetCaCertificateOk() (*string, bool)` + +GetCaCertificateOk returns a tuple with the CaCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCaCertificate + +`func (o *NDSLDAP) SetCaCertificate(v string)` + +SetCaCertificate sets CaCertificate field to given value. + +### HasCaCertificate + +`func (o *NDSLDAP) HasCaCertificate() bool` + +HasCaCertificate returns a boolean if a field has been set. + +### GetHostname + +`func (o *NDSLDAP) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *NDSLDAP) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *NDSLDAP) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *NDSLDAP) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSLDAP) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSLDAP) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSLDAP) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSLDAP) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetPort + +`func (o *NDSLDAP) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *NDSLDAP) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *NDSLDAP) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *NDSLDAP) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetUserToDNMapping + +`func (o *NDSLDAP) GetUserToDNMapping() []NDSUserToDNMapping` + +GetUserToDNMapping returns the UserToDNMapping field if non-nil, zero value otherwise. + +### GetUserToDNMappingOk + +`func (o *NDSLDAP) GetUserToDNMappingOk() (*[]NDSUserToDNMapping, bool)` + +GetUserToDNMappingOk returns a tuple with the UserToDNMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserToDNMapping + +`func (o *NDSLDAP) SetUserToDNMapping(v []NDSUserToDNMapping)` + +SetUserToDNMapping sets UserToDNMapping field to given value. + +### HasUserToDNMapping + +`func (o *NDSLDAP) HasUserToDNMapping() bool` + +HasUserToDNMapping returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSLDAPVerifyConnectivityJobRequest.md b/docs/docs/NDSLDAPVerifyConnectivityJobRequest.md new file mode 100644 index 00000000..0183925c --- /dev/null +++ b/docs/docs/NDSLDAPVerifyConnectivityJobRequest.md @@ -0,0 +1,186 @@ +# NDSLDAPVerifyConnectivityJobRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Request** | Pointer to [**NDSLDAPVerifyConnectivityJobRequestParams**](NDSLDAPVerifyConnectivityJobRequestParams.md) | | [optional] +**RequestId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. | [optional] [readonly] +**Validations** | Pointer to [**[]NDSLDAPVerifyConnectivityJobRequestValidation**](NDSLDAPVerifyConnectivityJobRequestValidation.md) | List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure. | [optional] [readonly] + +## Methods + +### NewNDSLDAPVerifyConnectivityJobRequest + +`func NewNDSLDAPVerifyConnectivityJobRequest() *NDSLDAPVerifyConnectivityJobRequest` + +NewNDSLDAPVerifyConnectivityJobRequest instantiates a new NDSLDAPVerifyConnectivityJobRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSLDAPVerifyConnectivityJobRequestWithDefaults + +`func NewNDSLDAPVerifyConnectivityJobRequestWithDefaults() *NDSLDAPVerifyConnectivityJobRequest` + +NewNDSLDAPVerifyConnectivityJobRequestWithDefaults instantiates a new NDSLDAPVerifyConnectivityJobRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetGroupId + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NDSLDAPVerifyConnectivityJobRequest) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NDSLDAPVerifyConnectivityJobRequest) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSLDAPVerifyConnectivityJobRequest) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSLDAPVerifyConnectivityJobRequest) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetRequest + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetRequest() NDSLDAPVerifyConnectivityJobRequestParams` + +GetRequest returns the Request field if non-nil, zero value otherwise. + +### GetRequestOk + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetRequestOk() (*NDSLDAPVerifyConnectivityJobRequestParams, bool)` + +GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequest + +`func (o *NDSLDAPVerifyConnectivityJobRequest) SetRequest(v NDSLDAPVerifyConnectivityJobRequestParams)` + +SetRequest sets Request field to given value. + +### HasRequest + +`func (o *NDSLDAPVerifyConnectivityJobRequest) HasRequest() bool` + +HasRequest returns a boolean if a field has been set. + +### GetRequestId + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *NDSLDAPVerifyConnectivityJobRequest) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *NDSLDAPVerifyConnectivityJobRequest) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### GetStatus + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NDSLDAPVerifyConnectivityJobRequest) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NDSLDAPVerifyConnectivityJobRequest) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetValidations + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetValidations() []NDSLDAPVerifyConnectivityJobRequestValidation` + +GetValidations returns the Validations field if non-nil, zero value otherwise. + +### GetValidationsOk + +`func (o *NDSLDAPVerifyConnectivityJobRequest) GetValidationsOk() (*[]NDSLDAPVerifyConnectivityJobRequestValidation, bool)` + +GetValidationsOk returns a tuple with the Validations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidations + +`func (o *NDSLDAPVerifyConnectivityJobRequest) SetValidations(v []NDSLDAPVerifyConnectivityJobRequestValidation)` + +SetValidations sets Validations field to given value. + +### HasValidations + +`func (o *NDSLDAPVerifyConnectivityJobRequest) HasValidations() bool` + +HasValidations returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSLDAPVerifyConnectivityJobRequestParams.md b/docs/docs/NDSLDAPVerifyConnectivityJobRequestParams.md new file mode 100644 index 00000000..52bada3c --- /dev/null +++ b/docs/docs/NDSLDAPVerifyConnectivityJobRequestParams.md @@ -0,0 +1,192 @@ +# NDSLDAPVerifyConnectivityJobRequestParams + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthzQueryTemplate** | Pointer to **string** | Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://tools.ietf.org/search/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516). | [optional] [default to "{USER}?memberOf?base"] +**BindPassword** | **string** | Password that MongoDB Cloud uses to authenticate the **bindUsername**. | +**BindUsername** | **string** | Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253. | +**CaCertificate** | Pointer to **string** | Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`. | [optional] +**Hostname** | **string** | Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster. | +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Port** | **int** | IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. | [default to 636] + +## Methods + +### NewNDSLDAPVerifyConnectivityJobRequestParams + +`func NewNDSLDAPVerifyConnectivityJobRequestParams(bindPassword string, bindUsername string, hostname string, port int, ) *NDSLDAPVerifyConnectivityJobRequestParams` + +NewNDSLDAPVerifyConnectivityJobRequestParams instantiates a new NDSLDAPVerifyConnectivityJobRequestParams object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSLDAPVerifyConnectivityJobRequestParamsWithDefaults + +`func NewNDSLDAPVerifyConnectivityJobRequestParamsWithDefaults() *NDSLDAPVerifyConnectivityJobRequestParams` + +NewNDSLDAPVerifyConnectivityJobRequestParamsWithDefaults instantiates a new NDSLDAPVerifyConnectivityJobRequestParams object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAuthzQueryTemplate + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetAuthzQueryTemplate() string` + +GetAuthzQueryTemplate returns the AuthzQueryTemplate field if non-nil, zero value otherwise. + +### GetAuthzQueryTemplateOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetAuthzQueryTemplateOk() (*string, bool)` + +GetAuthzQueryTemplateOk returns a tuple with the AuthzQueryTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthzQueryTemplate + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) SetAuthzQueryTemplate(v string)` + +SetAuthzQueryTemplate sets AuthzQueryTemplate field to given value. + +### HasAuthzQueryTemplate + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) HasAuthzQueryTemplate() bool` + +HasAuthzQueryTemplate returns a boolean if a field has been set. + +### GetBindPassword + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetBindPassword() string` + +GetBindPassword returns the BindPassword field if non-nil, zero value otherwise. + +### GetBindPasswordOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetBindPasswordOk() (*string, bool)` + +GetBindPasswordOk returns a tuple with the BindPassword field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBindPassword + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) SetBindPassword(v string)` + +SetBindPassword sets BindPassword field to given value. + + +### GetBindUsername + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetBindUsername() string` + +GetBindUsername returns the BindUsername field if non-nil, zero value otherwise. + +### GetBindUsernameOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetBindUsernameOk() (*string, bool)` + +GetBindUsernameOk returns a tuple with the BindUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBindUsername + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) SetBindUsername(v string)` + +SetBindUsername sets BindUsername field to given value. + + +### GetCaCertificate + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetCaCertificate() string` + +GetCaCertificate returns the CaCertificate field if non-nil, zero value otherwise. + +### GetCaCertificateOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetCaCertificateOk() (*string, bool)` + +GetCaCertificateOk returns a tuple with the CaCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCaCertificate + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) SetCaCertificate(v string)` + +SetCaCertificate sets CaCertificate field to given value. + +### HasCaCertificate + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) HasCaCertificate() bool` + +HasCaCertificate returns a boolean if a field has been set. + +### GetHostname + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + + +### GetLinks + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetPort + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *NDSLDAPVerifyConnectivityJobRequestParams) SetPort(v int)` + +SetPort sets Port field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSLDAPVerifyConnectivityJobRequestValidation.md b/docs/docs/NDSLDAPVerifyConnectivityJobRequestValidation.md new file mode 100644 index 00000000..620f401b --- /dev/null +++ b/docs/docs/NDSLDAPVerifyConnectivityJobRequestValidation.md @@ -0,0 +1,82 @@ +# NDSLDAPVerifyConnectivityJobRequestValidation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Human-readable string that indicates the result of this verification test. | [optional] [readonly] +**ValidationType** | Pointer to **string** | Human-readable label that identifies this verification test that MongoDB Cloud runs. | [optional] [readonly] + +## Methods + +### NewNDSLDAPVerifyConnectivityJobRequestValidation + +`func NewNDSLDAPVerifyConnectivityJobRequestValidation() *NDSLDAPVerifyConnectivityJobRequestValidation` + +NewNDSLDAPVerifyConnectivityJobRequestValidation instantiates a new NDSLDAPVerifyConnectivityJobRequestValidation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSLDAPVerifyConnectivityJobRequestValidationWithDefaults + +`func NewNDSLDAPVerifyConnectivityJobRequestValidationWithDefaults() *NDSLDAPVerifyConnectivityJobRequestValidation` + +NewNDSLDAPVerifyConnectivityJobRequestValidationWithDefaults instantiates a new NDSLDAPVerifyConnectivityJobRequestValidation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStatus + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetValidationType + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) GetValidationType() string` + +GetValidationType returns the ValidationType field if non-nil, zero value otherwise. + +### GetValidationTypeOk + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) GetValidationTypeOk() (*string, bool)` + +GetValidationTypeOk returns a tuple with the ValidationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidationType + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) SetValidationType(v string)` + +SetValidationType sets ValidationType field to given value. + +### HasValidationType + +`func (o *NDSLDAPVerifyConnectivityJobRequestValidation) HasValidationType() bool` + +HasValidationType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSLabel.md b/docs/docs/NDSLabel.md new file mode 100644 index 00000000..6a67f838 --- /dev/null +++ b/docs/docs/NDSLabel.md @@ -0,0 +1,82 @@ +# NDSLabel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Key applied to tag and categorize this component. | [optional] +**Value** | Pointer to **string** | Value set to the Key applied to tag and categorize this component. | [optional] + +## Methods + +### NewNDSLabel + +`func NewNDSLabel() *NDSLabel` + +NewNDSLabel instantiates a new NDSLabel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSLabelWithDefaults + +`func NewNDSLabelWithDefaults() *NDSLabel` + +NewNDSLabelWithDefaults instantiates a new NDSLabel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetKey + +`func (o *NDSLabel) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *NDSLabel) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *NDSLabel) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *NDSLabel) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValue + +`func (o *NDSLabel) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *NDSLabel) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *NDSLabel) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *NDSLabel) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSNotification.md b/docs/docs/NDSNotification.md new file mode 100644 index 00000000..7aafe8bd --- /dev/null +++ b/docs/docs/NDSNotification.md @@ -0,0 +1,129 @@ +# NDSNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**Severity** | Pointer to **string** | Degree of seriousness given to this notification. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewNDSNotification + +`func NewNDSNotification(typeName string, ) *NDSNotification` + +NewNDSNotification instantiates a new NDSNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSNotificationWithDefaults + +`func NewNDSNotificationWithDefaults() *NDSNotification` + +NewNDSNotificationWithDefaults instantiates a new NDSNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *NDSNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *NDSNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *NDSNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *NDSNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *NDSNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *NDSNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *NDSNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *NDSNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetSeverity + +`func (o *NDSNotification) GetSeverity() string` + +GetSeverity returns the Severity field if non-nil, zero value otherwise. + +### GetSeverityOk + +`func (o *NDSNotification) GetSeverityOk() (*string, bool)` + +GetSeverityOk returns a tuple with the Severity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSeverity + +`func (o *NDSNotification) SetSeverity(v string)` + +SetSeverity sets Severity field to given value. + +### HasSeverity + +`func (o *NDSNotification) HasSeverity() bool` + +HasSeverity returns a boolean if a field has been set. + +### GetTypeName + +`func (o *NDSNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *NDSNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *NDSNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSServerlessInstanceAudit.md b/docs/docs/NDSServerlessInstanceAudit.md new file mode 100644 index 00000000..c4f8bcff --- /dev/null +++ b/docs/docs/NDSServerlessInstanceAudit.md @@ -0,0 +1,353 @@ +# NDSServerlessInstanceAudit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**NDSServerlessInstanceAuditType**](NDSServerlessInstanceAuditType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewNDSServerlessInstanceAudit + +`func NewNDSServerlessInstanceAudit(created time.Time, eventTypeName NDSServerlessInstanceAuditType, id string, ) *NDSServerlessInstanceAudit` + +NewNDSServerlessInstanceAudit instantiates a new NDSServerlessInstanceAudit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSServerlessInstanceAuditWithDefaults + +`func NewNDSServerlessInstanceAuditWithDefaults() *NDSServerlessInstanceAudit` + +NewNDSServerlessInstanceAuditWithDefaults instantiates a new NDSServerlessInstanceAudit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *NDSServerlessInstanceAudit) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *NDSServerlessInstanceAudit) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *NDSServerlessInstanceAudit) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *NDSServerlessInstanceAudit) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NDSServerlessInstanceAudit) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NDSServerlessInstanceAudit) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NDSServerlessInstanceAudit) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *NDSServerlessInstanceAudit) GetEventTypeName() NDSServerlessInstanceAuditType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NDSServerlessInstanceAudit) GetEventTypeNameOk() (*NDSServerlessInstanceAuditType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NDSServerlessInstanceAudit) SetEventTypeName(v NDSServerlessInstanceAuditType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NDSServerlessInstanceAudit) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NDSServerlessInstanceAudit) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NDSServerlessInstanceAudit) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NDSServerlessInstanceAudit) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *NDSServerlessInstanceAudit) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NDSServerlessInstanceAudit) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NDSServerlessInstanceAudit) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *NDSServerlessInstanceAudit) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *NDSServerlessInstanceAudit) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *NDSServerlessInstanceAudit) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *NDSServerlessInstanceAudit) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSServerlessInstanceAudit) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSServerlessInstanceAudit) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSServerlessInstanceAudit) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSServerlessInstanceAudit) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *NDSServerlessInstanceAudit) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *NDSServerlessInstanceAudit) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *NDSServerlessInstanceAudit) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *NDSServerlessInstanceAudit) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *NDSServerlessInstanceAudit) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *NDSServerlessInstanceAudit) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *NDSServerlessInstanceAudit) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *NDSServerlessInstanceAudit) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *NDSServerlessInstanceAudit) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *NDSServerlessInstanceAudit) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *NDSServerlessInstanceAudit) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *NDSServerlessInstanceAudit) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *NDSServerlessInstanceAudit) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *NDSServerlessInstanceAudit) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *NDSServerlessInstanceAudit) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *NDSServerlessInstanceAudit) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *NDSServerlessInstanceAudit) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *NDSServerlessInstanceAudit) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *NDSServerlessInstanceAudit) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *NDSServerlessInstanceAudit) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *NDSServerlessInstanceAudit) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *NDSServerlessInstanceAudit) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *NDSServerlessInstanceAudit) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *NDSServerlessInstanceAudit) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSServerlessInstanceAuditType.md b/docs/docs/NDSServerlessInstanceAuditType.md new file mode 100644 index 00000000..9fe82b7f --- /dev/null +++ b/docs/docs/NDSServerlessInstanceAuditType.md @@ -0,0 +1,27 @@ +# NDSServerlessInstanceAuditType + +## Enum + + +* `CREATED` (value: `"SERVERLESS_INSTANCE_CREATED"`) + +* `READY` (value: `"SERVERLESS_INSTANCE_READY"`) + +* `UPDATE_SUBMITTED` (value: `"SERVERLESS_INSTANCE_UPDATE_SUBMITTED"`) + +* `UPDATE_STARTED` (value: `"SERVERLESS_INSTANCE_UPDATE_STARTED"`) + +* `UPDATE_COMPLETED` (value: `"SERVERLESS_INSTANCE_UPDATE_COMPLETED"`) + +* `DELETE_SUBMITTED` (value: `"SERVERLESS_INSTANCE_DELETE_SUBMITTED"`) + +* `DELETED` (value: `"SERVERLESS_INSTANCE_DELETED"`) + +* `BLOCKED` (value: `"SERVERLESS_INSTANCE_BLOCKED"`) + +* `UNBLOCKED` (value: `"SERVERLESS_INSTANCE_UNBLOCKED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSTenantEndpointAudit.md b/docs/docs/NDSTenantEndpointAudit.md new file mode 100644 index 00000000..da02e1d4 --- /dev/null +++ b/docs/docs/NDSTenantEndpointAudit.md @@ -0,0 +1,405 @@ +# NDSTenantEndpointAudit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EndpointId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the endpoint associated with this event. | [optional] [readonly] +**EventTypeName** | [**NDSTenantEndpointAuditType**](NDSTenantEndpointAuditType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**ProviderEndpointId** | Pointer to **string** | Unique identification string that the cloud provider uses to identify the private endpoint. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewNDSTenantEndpointAudit + +`func NewNDSTenantEndpointAudit(created time.Time, eventTypeName NDSTenantEndpointAuditType, id string, ) *NDSTenantEndpointAudit` + +NewNDSTenantEndpointAudit instantiates a new NDSTenantEndpointAudit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSTenantEndpointAuditWithDefaults + +`func NewNDSTenantEndpointAuditWithDefaults() *NDSTenantEndpointAudit` + +NewNDSTenantEndpointAuditWithDefaults instantiates a new NDSTenantEndpointAudit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *NDSTenantEndpointAudit) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *NDSTenantEndpointAudit) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *NDSTenantEndpointAudit) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *NDSTenantEndpointAudit) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NDSTenantEndpointAudit) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NDSTenantEndpointAudit) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NDSTenantEndpointAudit) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEndpointId + +`func (o *NDSTenantEndpointAudit) GetEndpointId() string` + +GetEndpointId returns the EndpointId field if non-nil, zero value otherwise. + +### GetEndpointIdOk + +`func (o *NDSTenantEndpointAudit) GetEndpointIdOk() (*string, bool)` + +GetEndpointIdOk returns a tuple with the EndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointId + +`func (o *NDSTenantEndpointAudit) SetEndpointId(v string)` + +SetEndpointId sets EndpointId field to given value. + +### HasEndpointId + +`func (o *NDSTenantEndpointAudit) HasEndpointId() bool` + +HasEndpointId returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *NDSTenantEndpointAudit) GetEventTypeName() NDSTenantEndpointAuditType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NDSTenantEndpointAudit) GetEventTypeNameOk() (*NDSTenantEndpointAuditType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NDSTenantEndpointAudit) SetEventTypeName(v NDSTenantEndpointAuditType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NDSTenantEndpointAudit) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NDSTenantEndpointAudit) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NDSTenantEndpointAudit) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NDSTenantEndpointAudit) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *NDSTenantEndpointAudit) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NDSTenantEndpointAudit) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NDSTenantEndpointAudit) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *NDSTenantEndpointAudit) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *NDSTenantEndpointAudit) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *NDSTenantEndpointAudit) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *NDSTenantEndpointAudit) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSTenantEndpointAudit) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSTenantEndpointAudit) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSTenantEndpointAudit) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSTenantEndpointAudit) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *NDSTenantEndpointAudit) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *NDSTenantEndpointAudit) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *NDSTenantEndpointAudit) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *NDSTenantEndpointAudit) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetProviderEndpointId + +`func (o *NDSTenantEndpointAudit) GetProviderEndpointId() string` + +GetProviderEndpointId returns the ProviderEndpointId field if non-nil, zero value otherwise. + +### GetProviderEndpointIdOk + +`func (o *NDSTenantEndpointAudit) GetProviderEndpointIdOk() (*string, bool)` + +GetProviderEndpointIdOk returns a tuple with the ProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderEndpointId + +`func (o *NDSTenantEndpointAudit) SetProviderEndpointId(v string)` + +SetProviderEndpointId sets ProviderEndpointId field to given value. + +### HasProviderEndpointId + +`func (o *NDSTenantEndpointAudit) HasProviderEndpointId() bool` + +HasProviderEndpointId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *NDSTenantEndpointAudit) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *NDSTenantEndpointAudit) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *NDSTenantEndpointAudit) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *NDSTenantEndpointAudit) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *NDSTenantEndpointAudit) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *NDSTenantEndpointAudit) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *NDSTenantEndpointAudit) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *NDSTenantEndpointAudit) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *NDSTenantEndpointAudit) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *NDSTenantEndpointAudit) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *NDSTenantEndpointAudit) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *NDSTenantEndpointAudit) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *NDSTenantEndpointAudit) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *NDSTenantEndpointAudit) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *NDSTenantEndpointAudit) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *NDSTenantEndpointAudit) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *NDSTenantEndpointAudit) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *NDSTenantEndpointAudit) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *NDSTenantEndpointAudit) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *NDSTenantEndpointAudit) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSTenantEndpointAuditType.md b/docs/docs/NDSTenantEndpointAuditType.md new file mode 100644 index 00000000..3bfbc8fb --- /dev/null +++ b/docs/docs/NDSTenantEndpointAuditType.md @@ -0,0 +1,29 @@ +# NDSTenantEndpointAuditType + +## Enum + + +* `CREATED` (value: `"TENANT_ENDPOINT_CREATED"`) + +* `RESERVED` (value: `"TENANT_ENDPOINT_RESERVED"`) + +* `RESERVATION_FAILED` (value: `"TENANT_ENDPOINT_RESERVATION_FAILED"`) + +* `UPDATED` (value: `"TENANT_ENDPOINT_UPDATED"`) + +* `INITIATING` (value: `"TENANT_ENDPOINT_INITIATING"`) + +* `AVAILABLE` (value: `"TENANT_ENDPOINT_AVAILABLE"`) + +* `FAILED` (value: `"TENANT_ENDPOINT_FAILED"`) + +* `DELETING` (value: `"TENANT_ENDPOINT_DELETING"`) + +* `DELETED` (value: `"TENANT_ENDPOINT_DELETED"`) + +* `EXPIRED` (value: `"TENANT_ENDPOINT_EXPIRED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSUserToDNMapping.md b/docs/docs/NDSUserToDNMapping.md new file mode 100644 index 00000000..8e776163 --- /dev/null +++ b/docs/docs/NDSUserToDNMapping.md @@ -0,0 +1,103 @@ +# NDSUserToDNMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LdapQuery** | Pointer to **string** | Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516). | [optional] +**Match** | **string** | Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses. | +**Substitution** | Pointer to **string** | Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN). | [optional] + +## Methods + +### NewNDSUserToDNMapping + +`func NewNDSUserToDNMapping(match string, ) *NDSUserToDNMapping` + +NewNDSUserToDNMapping instantiates a new NDSUserToDNMapping object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSUserToDNMappingWithDefaults + +`func NewNDSUserToDNMappingWithDefaults() *NDSUserToDNMapping` + +NewNDSUserToDNMappingWithDefaults instantiates a new NDSUserToDNMapping object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLdapQuery + +`func (o *NDSUserToDNMapping) GetLdapQuery() string` + +GetLdapQuery returns the LdapQuery field if non-nil, zero value otherwise. + +### GetLdapQueryOk + +`func (o *NDSUserToDNMapping) GetLdapQueryOk() (*string, bool)` + +GetLdapQueryOk returns a tuple with the LdapQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLdapQuery + +`func (o *NDSUserToDNMapping) SetLdapQuery(v string)` + +SetLdapQuery sets LdapQuery field to given value. + +### HasLdapQuery + +`func (o *NDSUserToDNMapping) HasLdapQuery() bool` + +HasLdapQuery returns a boolean if a field has been set. + +### GetMatch + +`func (o *NDSUserToDNMapping) GetMatch() string` + +GetMatch returns the Match field if non-nil, zero value otherwise. + +### GetMatchOk + +`func (o *NDSUserToDNMapping) GetMatchOk() (*string, bool)` + +GetMatchOk returns a tuple with the Match field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatch + +`func (o *NDSUserToDNMapping) SetMatch(v string)` + +SetMatch sets Match field to given value. + + +### GetSubstitution + +`func (o *NDSUserToDNMapping) GetSubstitution() string` + +GetSubstitution returns the Substitution field if non-nil, zero value otherwise. + +### GetSubstitutionOk + +`func (o *NDSUserToDNMapping) GetSubstitutionOk() (*string, bool)` + +GetSubstitutionOk returns a tuple with the Substitution field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubstitution + +`func (o *NDSUserToDNMapping) SetSubstitution(v string)` + +SetSubstitution sets Substitution field to given value. + +### HasSubstitution + +`func (o *NDSUserToDNMapping) HasSubstitution() bool` + +HasSubstitution returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSX509UserAuthenticationAlertConfigViewForNdsGroup.md b/docs/docs/NDSX509UserAuthenticationAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..43231740 --- /dev/null +++ b/docs/docs/NDSX509UserAuthenticationAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# NDSX509UserAuthenticationAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**NDSX509UserAuthenticationEventTypeViewAlertable**](NDSX509UserAuthenticationEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**LessThanDaysThreshold**](LessThanDaysThreshold.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewNDSX509UserAuthenticationAlertConfigViewForNdsGroup + +`func NewNDSX509UserAuthenticationAlertConfigViewForNdsGroup(eventTypeName NDSX509UserAuthenticationEventTypeViewAlertable, ) *NDSX509UserAuthenticationAlertConfigViewForNdsGroup` + +NewNDSX509UserAuthenticationAlertConfigViewForNdsGroup instantiates a new NDSX509UserAuthenticationAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNDSX509UserAuthenticationAlertConfigViewForNdsGroupWithDefaults + +`func NewNDSX509UserAuthenticationAlertConfigViewForNdsGroupWithDefaults() *NDSX509UserAuthenticationAlertConfigViewForNdsGroup` + +NewNDSX509UserAuthenticationAlertConfigViewForNdsGroupWithDefaults instantiates a new NDSX509UserAuthenticationAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetEventTypeName() NDSX509UserAuthenticationEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*NDSX509UserAuthenticationEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetEventTypeName(v NDSX509UserAuthenticationEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetThreshold() LessThanDaysThreshold` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetThresholdOk() (*LessThanDaysThreshold, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetThreshold(v LessThanDaysThreshold)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *NDSX509UserAuthenticationAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NDSX509UserAuthenticationEventTypeViewAlertable.md b/docs/docs/NDSX509UserAuthenticationEventTypeViewAlertable.md new file mode 100644 index 00000000..7827b648 --- /dev/null +++ b/docs/docs/NDSX509UserAuthenticationEventTypeViewAlertable.md @@ -0,0 +1,15 @@ +# NDSX509UserAuthenticationEventTypeViewAlertable + +## Enum + + +* `CUSTOMER_CA_EXPIRATION_CHECK` (value: `"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK"`) + +* `CUSTOMER_CRL_EXPIRATION_CHECK` (value: `"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK"`) + +* `MANAGED_USER_CERTS_EXPIRATION_CHECK` (value: `"NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NamespaceObj.md b/docs/docs/NamespaceObj.md new file mode 100644 index 00000000..d82f37af --- /dev/null +++ b/docs/docs/NamespaceObj.md @@ -0,0 +1,82 @@ +# NamespaceObj + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Namespace** | Pointer to **string** | Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `<database>.<collection>`. | [optional] [readonly] +**Type** | Pointer to **string** | Human-readable label that identifies the type of namespace. | [optional] [readonly] [default to "collection"] + +## Methods + +### NewNamespaceObj + +`func NewNamespaceObj() *NamespaceObj` + +NewNamespaceObj instantiates a new NamespaceObj object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNamespaceObjWithDefaults + +`func NewNamespaceObjWithDefaults() *NamespaceObj` + +NewNamespaceObjWithDefaults instantiates a new NamespaceObj object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNamespace + +`func (o *NamespaceObj) GetNamespace() string` + +GetNamespace returns the Namespace field if non-nil, zero value otherwise. + +### GetNamespaceOk + +`func (o *NamespaceObj) GetNamespaceOk() (*string, bool)` + +GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNamespace + +`func (o *NamespaceObj) SetNamespace(v string)` + +SetNamespace sets Namespace field to given value. + +### HasNamespace + +`func (o *NamespaceObj) HasNamespace() bool` + +HasNamespace returns a boolean if a field has been set. + +### GetType + +`func (o *NamespaceObj) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NamespaceObj) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NamespaceObj) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *NamespaceObj) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Namespaces.md b/docs/docs/Namespaces.md new file mode 100644 index 00000000..40e5ee36 --- /dev/null +++ b/docs/docs/Namespaces.md @@ -0,0 +1,56 @@ +# Namespaces + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Namespaces** | Pointer to [**[]NamespaceObj**](NamespaceObj.md) | List that contains each combination of database, collection, and type on the specified host. | [optional] [readonly] + +## Methods + +### NewNamespaces + +`func NewNamespaces() *Namespaces` + +NewNamespaces instantiates a new Namespaces object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNamespacesWithDefaults + +`func NewNamespacesWithDefaults() *Namespaces` + +NewNamespacesWithDefaults instantiates a new Namespaces object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNamespaces + +`func (o *Namespaces) GetNamespaces() []NamespaceObj` + +GetNamespaces returns the Namespaces field if non-nil, zero value otherwise. + +### GetNamespacesOk + +`func (o *Namespaces) GetNamespacesOk() (*[]NamespaceObj, bool)` + +GetNamespacesOk returns a tuple with the Namespaces field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNamespaces + +`func (o *Namespaces) SetNamespaces(v []NamespaceObj)` + +SetNamespaces sets Namespaces field to given value. + +### HasNamespaces + +`func (o *Namespaces) HasNamespaces() bool` + +HasNamespaces returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NetPeerRequestBase.md b/docs/docs/NetPeerRequestBase.md new file mode 100644 index 00000000..7cb6c43e --- /dev/null +++ b/docs/docs/NetPeerRequestBase.md @@ -0,0 +1,72 @@ +# NetPeerRequestBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContainerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. | +**ProviderName** | **string** | Cloud service provider that determines the needed settings to configure the network connection for a virtual private connection. | + +## Methods + +### NewNetPeerRequestBase + +`func NewNetPeerRequestBase(containerId string, providerName string, ) *NetPeerRequestBase` + +NewNetPeerRequestBase instantiates a new NetPeerRequestBase object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNetPeerRequestBaseWithDefaults + +`func NewNetPeerRequestBaseWithDefaults() *NetPeerRequestBase` + +NewNetPeerRequestBaseWithDefaults instantiates a new NetPeerRequestBase object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContainerId + +`func (o *NetPeerRequestBase) GetContainerId() string` + +GetContainerId returns the ContainerId field if non-nil, zero value otherwise. + +### GetContainerIdOk + +`func (o *NetPeerRequestBase) GetContainerIdOk() (*string, bool)` + +GetContainerIdOk returns a tuple with the ContainerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainerId + +`func (o *NetPeerRequestBase) SetContainerId(v string)` + +SetContainerId sets ContainerId field to given value. + + +### GetProviderName + +`func (o *NetPeerRequestBase) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *NetPeerRequestBase) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *NetPeerRequestBase) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NetworkPeeringApi.md b/docs/docs/NetworkPeeringApi.md new file mode 100644 index 00000000..ccc41cc4 --- /dev/null +++ b/docs/docs/NetworkPeeringApi.md @@ -0,0 +1,1029 @@ +# \NetworkPeeringApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreatePeeringConnection**](NetworkPeeringApi.md#CreatePeeringConnection) | **Post** /api/atlas/v2/groups/{groupId}/peers | Create One New Network Peering Connection +[**CreatePeeringContainer**](NetworkPeeringApi.md#CreatePeeringContainer) | **Post** /api/atlas/v2/groups/{groupId}/containers | Create One New Network Peering Container +[**DeletePeeringConnection**](NetworkPeeringApi.md#DeletePeeringConnection) | **Delete** /api/atlas/v2/groups/{groupId}/peers/{peerId} | Remove One Existing Network Peering Connection +[**DeletePeeringContainer**](NetworkPeeringApi.md#DeletePeeringContainer) | **Delete** /api/atlas/v2/groups/{groupId}/containers/{containerId} | Remove One Network Peering Container +[**DisablePeering**](NetworkPeeringApi.md#DisablePeering) | **Patch** /api/atlas/v2/groups/{groupId}/privateIpMode | Disable Connect via Peering Only Mode for One Project +[**GetPeeringConnection**](NetworkPeeringApi.md#GetPeeringConnection) | **Get** /api/atlas/v2/groups/{groupId}/peers/{peerId} | Return One Network Peering Connection in One Project +[**GetPeeringContainer**](NetworkPeeringApi.md#GetPeeringContainer) | **Get** /api/atlas/v2/groups/{groupId}/containers/{containerId} | Return One Network Peering Container +[**ListPeeringConnections**](NetworkPeeringApi.md#ListPeeringConnections) | **Get** /api/atlas/v2/groups/{groupId}/peers | Return All Network Peering Connections in One Project +[**ListPeeringContainerByCloudProvider**](NetworkPeeringApi.md#ListPeeringContainerByCloudProvider) | **Get** /api/atlas/v2/groups/{groupId}/containers | Return All Network Peering Containers in One Project for One Cloud Provider +[**ListPeeringContainers**](NetworkPeeringApi.md#ListPeeringContainers) | **Get** /api/atlas/v2/groups/{groupId}/containers/all | Return All Network Peering Containers in One Project +[**UpdatePeeringConnection**](NetworkPeeringApi.md#UpdatePeeringConnection) | **Patch** /api/atlas/v2/groups/{groupId}/peers/{peerId} | Update One New Network Peering Connection +[**UpdatePeeringContainer**](NetworkPeeringApi.md#UpdatePeeringContainer) | **Patch** /api/atlas/v2/groups/{groupId}/containers/{containerId} | Update One Network Peering Container +[**VerifyConnectViaPeeringOnlyModeForOneProject**](NetworkPeeringApi.md#VerifyConnectViaPeeringOnlyModeForOneProject) | **Get** /api/atlas/v2/groups/{groupId}/privateIpMode | Verify Connect via Peering Only Mode for One Project + + + +## CreatePeeringConnection + +> CreatePeeringConnection200Response CreatePeeringConnection(ctx, groupId).ContainerPeerViewRequest(containerPeerViewRequest).Execute() + +Create One New Network Peering Connection + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + containerPeerViewRequest := openapiclient.ContainerPeerViewRequest{AWSPeerVpcRequest: openapiclient.NewAWSPeerVpcRequest("32b6e34b3d91647abb20e7b8", "ProviderName_example", "AccepterRegionName_example", "AwsAccountId_example", "RouteTableCidrBlock_example", "VpcId_example")} // ContainerPeerViewRequest | + + resp, r, err := sdk.NetworkPeeringApi.CreatePeeringConnection(context.Background(), groupId).ContainerPeerViewRequest(containerPeerViewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.CreatePeeringConnection``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreatePeeringConnection`: CreatePeeringConnection200Response + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.CreatePeeringConnection`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePeeringConnectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **containerPeerViewRequest** | [**ContainerPeerViewRequest**](ContainerPeerViewRequest.md) | Create one network peering connection. | + +### Return type + +[**CreatePeeringConnection200Response**](CreatePeeringConnection200Response.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreatePeeringContainer + +> CloudProviderContainer CreatePeeringContainer(ctx, groupId).CloudProviderContainer(cloudProviderContainer).Execute() + +Create One New Network Peering Container + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProviderContainer := openapiclient.CloudProviderContainer{AWSCloudProviderContainer: openapiclient.NewAWSCloudProviderContainer("RegionName_example")} // CloudProviderContainer | + + resp, r, err := sdk.NetworkPeeringApi.CreatePeeringContainer(context.Background(), groupId).CloudProviderContainer(cloudProviderContainer).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.CreatePeeringContainer``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreatePeeringContainer`: CloudProviderContainer + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.CreatePeeringContainer`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePeeringContainerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **cloudProviderContainer** | [**CloudProviderContainer**](CloudProviderContainer.md) | Creates one new network peering container in the specified project. | + +### Return type + +[**CloudProviderContainer**](CloudProviderContainer.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePeeringConnection + +> DeletePeeringConnection(ctx, groupId, peerId).Execute() + +Remove One Existing Network Peering Connection + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + peerId := "peerId_example" // string | + + r, err := sdk.NetworkPeeringApi.DeletePeeringConnection(context.Background(), groupId, peerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.DeletePeeringConnection``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**peerId** | **string** | Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePeeringConnectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePeeringContainer + +> DeletePeeringContainer(ctx, groupId, containerId).Execute() + +Remove One Network Peering Container + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + containerId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.NetworkPeeringApi.DeletePeeringContainer(context.Background(), groupId, containerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.DeletePeeringContainer``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**containerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePeeringContainerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DisablePeering + +> PrivateIPMode DisablePeering(ctx, groupId).PrivateIPMode(privateIPMode).Execute() + +Disable Connect via Peering Only Mode for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + privateIPMode := *openapiclient.NewPrivateIPMode(false) // PrivateIPMode | + + resp, r, err := sdk.NetworkPeeringApi.DisablePeering(context.Background(), groupId).PrivateIPMode(privateIPMode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.DisablePeering``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DisablePeering`: PrivateIPMode + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.DisablePeering`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisablePeeringRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **privateIPMode** | [**PrivateIPMode**](PrivateIPMode.md) | Disables Connect via Peering Only mode for the specified project. | + +### Return type + +[**PrivateIPMode**](PrivateIPMode.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPeeringConnection + +> GetPeeringConnection200Response GetPeeringConnection(ctx, groupId, peerId).Execute() + +Return One Network Peering Connection in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + peerId := "peerId_example" // string | + + resp, r, err := sdk.NetworkPeeringApi.GetPeeringConnection(context.Background(), groupId, peerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.GetPeeringConnection``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetPeeringConnection`: GetPeeringConnection200Response + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.GetPeeringConnection`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**peerId** | **string** | Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeeringConnectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**GetPeeringConnection200Response**](GetPeeringConnection200Response.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPeeringContainer + +> CloudProviderContainer GetPeeringContainer(ctx, groupId, containerId).Execute() + +Return One Network Peering Container + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + containerId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.NetworkPeeringApi.GetPeeringContainer(context.Background(), groupId, containerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.GetPeeringContainer``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetPeeringContainer`: CloudProviderContainer + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.GetPeeringContainer`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**containerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeeringContainerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**CloudProviderContainer**](CloudProviderContainer.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPeeringConnections + +> ListPeeringConnections200Response ListPeeringConnections(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).ProviderName(providerName).Execute() + +Return All Network Peering Connections in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + providerName := "providerName_example" // string | (optional) (default to "AWS") + + resp, r, err := sdk.NetworkPeeringApi.ListPeeringConnections(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).ProviderName(providerName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.ListPeeringConnections``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPeeringConnections`: ListPeeringConnections200Response + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.ListPeeringConnections`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPeeringConnectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **providerName** | **string** | Cloud service provider to use for this VPC peering connection. | [default to "AWS"] + +### Return type + +[**ListPeeringConnections200Response**](ListPeeringConnections200Response.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPeeringContainerByCloudProvider + +> PaginatedCloudProviderContainer ListPeeringContainerByCloudProvider(ctx, groupId).ProviderName(providerName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Network Peering Containers in One Project for One Cloud Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + providerName := "providerName_example" // string | (default to "AWS") + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.NetworkPeeringApi.ListPeeringContainerByCloudProvider(context.Background(), groupId).ProviderName(providerName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.ListPeeringContainerByCloudProvider``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPeeringContainerByCloudProvider`: PaginatedCloudProviderContainer + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.ListPeeringContainerByCloudProvider`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPeeringContainerByCloudProviderRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **providerName** | **string** | Cloud service provider that serves the desired network peering containers. | [default to "AWS"] + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedCloudProviderContainer**](PaginatedCloudProviderContainer.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPeeringContainers + +> PaginatedCloudProviderContainer ListPeeringContainers(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Network Peering Containers in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.NetworkPeeringApi.ListPeeringContainers(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.ListPeeringContainers``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPeeringContainers`: PaginatedCloudProviderContainer + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.ListPeeringContainers`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPeeringContainersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedCloudProviderContainer**](PaginatedCloudProviderContainer.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdatePeeringConnection + +> GetPeeringConnection200Response UpdatePeeringConnection(ctx, groupId, peerId).ContainerPeerViewRequest(containerPeerViewRequest).Execute() + +Update One New Network Peering Connection + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + peerId := "peerId_example" // string | + containerPeerViewRequest := openapiclient.ContainerPeerViewRequest{AWSPeerVpcRequest: openapiclient.NewAWSPeerVpcRequest("32b6e34b3d91647abb20e7b8", "ProviderName_example", "AccepterRegionName_example", "AwsAccountId_example", "RouteTableCidrBlock_example", "VpcId_example")} // ContainerPeerViewRequest | + + resp, r, err := sdk.NetworkPeeringApi.UpdatePeeringConnection(context.Background(), groupId, peerId).ContainerPeerViewRequest(containerPeerViewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.UpdatePeeringConnection``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdatePeeringConnection`: GetPeeringConnection200Response + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.UpdatePeeringConnection`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**peerId** | **string** | Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePeeringConnectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **containerPeerViewRequest** | [**ContainerPeerViewRequest**](ContainerPeerViewRequest.md) | Modify one network peering connection. | + +### Return type + +[**GetPeeringConnection200Response**](GetPeeringConnection200Response.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdatePeeringContainer + +> CloudProviderContainer UpdatePeeringContainer(ctx, groupId, containerId).CloudProviderContainer(cloudProviderContainer).Execute() + +Update One Network Peering Container + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + containerId := "32b6e34b3d91647abb20e7b8" // string | + cloudProviderContainer := openapiclient.CloudProviderContainer{AWSCloudProviderContainer: openapiclient.NewAWSCloudProviderContainer("RegionName_example")} // CloudProviderContainer | + + resp, r, err := sdk.NetworkPeeringApi.UpdatePeeringContainer(context.Background(), groupId, containerId).CloudProviderContainer(cloudProviderContainer).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.UpdatePeeringContainer``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdatePeeringContainer`: CloudProviderContainer + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.UpdatePeeringContainer`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**containerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePeeringContainerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **cloudProviderContainer** | [**CloudProviderContainer**](CloudProviderContainer.md) | Updates the network details and labels of one specified network peering container in the specified project. | + +### Return type + +[**CloudProviderContainer**](CloudProviderContainer.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## VerifyConnectViaPeeringOnlyModeForOneProject + +> PrivateIPMode VerifyConnectViaPeeringOnlyModeForOneProject(ctx, groupId).Execute() + +Verify Connect via Peering Only Mode for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.NetworkPeeringApi.VerifyConnectViaPeeringOnlyModeForOneProject(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NetworkPeeringApi.VerifyConnectViaPeeringOnlyModeForOneProject``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `VerifyConnectViaPeeringOnlyModeForOneProject`: PrivateIPMode + fmt.Fprintf(os.Stdout, "Response from `NetworkPeeringApi.VerifyConnectViaPeeringOnlyModeForOneProject`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiVerifyConnectViaPeeringOnlyModeForOneProjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PrivateIPMode**](PrivateIPMode.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/NetworkPermissionEntry.md b/docs/docs/NetworkPermissionEntry.md new file mode 100644 index 00000000..dd660649 --- /dev/null +++ b/docs/docs/NetworkPermissionEntry.md @@ -0,0 +1,212 @@ +# NetworkPermissionEntry + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsSecurityGroup** | Pointer to **string** | Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**. | [optional] +**CidrBlock** | Pointer to **string** | Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**. | [optional] +**Comment** | Pointer to **string** | Remark that explains the purpose or scope of this IP access list entry. | [optional] +**DeleteAfterDate** | Pointer to **time.Time** | Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries. | [optional] [readonly] +**IpAddress** | Pointer to **string** | IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**. | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewNetworkPermissionEntry + +`func NewNetworkPermissionEntry() *NetworkPermissionEntry` + +NewNetworkPermissionEntry instantiates a new NetworkPermissionEntry object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNetworkPermissionEntryWithDefaults + +`func NewNetworkPermissionEntryWithDefaults() *NetworkPermissionEntry` + +NewNetworkPermissionEntryWithDefaults instantiates a new NetworkPermissionEntry object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAwsSecurityGroup + +`func (o *NetworkPermissionEntry) GetAwsSecurityGroup() string` + +GetAwsSecurityGroup returns the AwsSecurityGroup field if non-nil, zero value otherwise. + +### GetAwsSecurityGroupOk + +`func (o *NetworkPermissionEntry) GetAwsSecurityGroupOk() (*string, bool)` + +GetAwsSecurityGroupOk returns a tuple with the AwsSecurityGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsSecurityGroup + +`func (o *NetworkPermissionEntry) SetAwsSecurityGroup(v string)` + +SetAwsSecurityGroup sets AwsSecurityGroup field to given value. + +### HasAwsSecurityGroup + +`func (o *NetworkPermissionEntry) HasAwsSecurityGroup() bool` + +HasAwsSecurityGroup returns a boolean if a field has been set. + +### GetCidrBlock + +`func (o *NetworkPermissionEntry) GetCidrBlock() string` + +GetCidrBlock returns the CidrBlock field if non-nil, zero value otherwise. + +### GetCidrBlockOk + +`func (o *NetworkPermissionEntry) GetCidrBlockOk() (*string, bool)` + +GetCidrBlockOk returns a tuple with the CidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidrBlock + +`func (o *NetworkPermissionEntry) SetCidrBlock(v string)` + +SetCidrBlock sets CidrBlock field to given value. + +### HasCidrBlock + +`func (o *NetworkPermissionEntry) HasCidrBlock() bool` + +HasCidrBlock returns a boolean if a field has been set. + +### GetComment + +`func (o *NetworkPermissionEntry) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NetworkPermissionEntry) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NetworkPermissionEntry) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NetworkPermissionEntry) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetDeleteAfterDate + +`func (o *NetworkPermissionEntry) GetDeleteAfterDate() time.Time` + +GetDeleteAfterDate returns the DeleteAfterDate field if non-nil, zero value otherwise. + +### GetDeleteAfterDateOk + +`func (o *NetworkPermissionEntry) GetDeleteAfterDateOk() (*time.Time, bool)` + +GetDeleteAfterDateOk returns a tuple with the DeleteAfterDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteAfterDate + +`func (o *NetworkPermissionEntry) SetDeleteAfterDate(v time.Time)` + +SetDeleteAfterDate sets DeleteAfterDate field to given value. + +### HasDeleteAfterDate + +`func (o *NetworkPermissionEntry) HasDeleteAfterDate() bool` + +HasDeleteAfterDate returns a boolean if a field has been set. + +### GetGroupId + +`func (o *NetworkPermissionEntry) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NetworkPermissionEntry) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NetworkPermissionEntry) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NetworkPermissionEntry) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *NetworkPermissionEntry) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *NetworkPermissionEntry) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *NetworkPermissionEntry) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *NetworkPermissionEntry) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetLinks + +`func (o *NetworkPermissionEntry) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NetworkPermissionEntry) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NetworkPermissionEntry) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NetworkPermissionEntry) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NetworkPermissionEntryStatus.md b/docs/docs/NetworkPermissionEntryStatus.md new file mode 100644 index 00000000..7d236069 --- /dev/null +++ b/docs/docs/NetworkPermissionEntryStatus.md @@ -0,0 +1,51 @@ +# NetworkPermissionEntryStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**STATUS** | **string** | State of the access list entry when MongoDB Cloud made this request. | Status | Activity | |---|---| | `ACTIVE` | This access list entry applies to all relevant cloud providers. | | `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. | | `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. | | [readonly] + +## Methods + +### NewNetworkPermissionEntryStatus + +`func NewNetworkPermissionEntryStatus(sTATUS string, ) *NetworkPermissionEntryStatus` + +NewNetworkPermissionEntryStatus instantiates a new NetworkPermissionEntryStatus object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNetworkPermissionEntryStatusWithDefaults + +`func NewNetworkPermissionEntryStatusWithDefaults() *NetworkPermissionEntryStatus` + +NewNetworkPermissionEntryStatusWithDefaults instantiates a new NetworkPermissionEntryStatus object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetSTATUS + +`func (o *NetworkPermissionEntryStatus) GetSTATUS() string` + +GetSTATUS returns the STATUS field if non-nil, zero value otherwise. + +### GetSTATUSOk + +`func (o *NetworkPermissionEntryStatus) GetSTATUSOk() (*string, bool)` + +GetSTATUSOk returns a tuple with the STATUS field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSTATUS + +`func (o *NetworkPermissionEntryStatus) SetSTATUS(v string)` + +SetSTATUS sets STATUS field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NewRelic.md b/docs/docs/NewRelic.md new file mode 100644 index 00000000..61b7edb2 --- /dev/null +++ b/docs/docs/NewRelic.md @@ -0,0 +1,140 @@ +# NewRelic + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | **string** | Unique 40-hexadecimal digit string that identifies your New Relic account. | +**LicenseKey** | **string** | Unique 40-hexadecimal digit string that identifies your New Relic license. **IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration. To learn more, see the <a href=\"https://discuss.newrelic.com/t/new-relic-plugin-eol-wednesday-june-16th-2021/127267\" target=\"_blank\">New Relic Plugin EOL Statement</a> Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments. | +**ReadToken** | **string** | Query key used to access your New Relic account. | +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] +**WriteToken** | **string** | Insert key associated with your New Relic account. | + +## Methods + +### NewNewRelic + +`func NewNewRelic(accountId string, licenseKey string, readToken string, writeToken string, ) *NewRelic` + +NewNewRelic instantiates a new NewRelic object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNewRelicWithDefaults + +`func NewNewRelicWithDefaults() *NewRelic` + +NewNewRelicWithDefaults instantiates a new NewRelic object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccountId + +`func (o *NewRelic) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *NewRelic) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *NewRelic) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + + +### GetLicenseKey + +`func (o *NewRelic) GetLicenseKey() string` + +GetLicenseKey returns the LicenseKey field if non-nil, zero value otherwise. + +### GetLicenseKeyOk + +`func (o *NewRelic) GetLicenseKeyOk() (*string, bool)` + +GetLicenseKeyOk returns a tuple with the LicenseKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenseKey + +`func (o *NewRelic) SetLicenseKey(v string)` + +SetLicenseKey sets LicenseKey field to given value. + + +### GetReadToken + +`func (o *NewRelic) GetReadToken() string` + +GetReadToken returns the ReadToken field if non-nil, zero value otherwise. + +### GetReadTokenOk + +`func (o *NewRelic) GetReadTokenOk() (*string, bool)` + +GetReadTokenOk returns a tuple with the ReadToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadToken + +`func (o *NewRelic) SetReadToken(v string)` + +SetReadToken sets ReadToken field to given value. + + +### GetType + +`func (o *NewRelic) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NewRelic) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NewRelic) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *NewRelic) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetWriteToken + +`func (o *NewRelic) GetWriteToken() string` + +GetWriteToken returns the WriteToken field if non-nil, zero value otherwise. + +### GetWriteTokenOk + +`func (o *NewRelic) GetWriteTokenOk() (*string, bool)` + +GetWriteTokenOk returns a tuple with the WriteToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWriteToken + +`func (o *NewRelic) SetWriteToken(v string)` + +SetWriteToken sets WriteToken field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Notification.md b/docs/docs/Notification.md new file mode 100644 index 00000000..9b55b9f8 --- /dev/null +++ b/docs/docs/Notification.md @@ -0,0 +1,727 @@ +# Notification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DatadogApiKey** | Pointer to **string** | Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**DatadogRegion** | Pointer to **string** | Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. To learn more about Datadog's regions, see <a href=\"https://docs.datadoghq.com/getting_started/site/\" target=\"_blank\" rel=\"noopener noreferrer\">Datadog Sites</a>. | [optional] [default to "US"] +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | +**EmailAddress** | Pointer to **string** | Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don’t need to set this value to send emails to individual or groups of MongoDB Cloud users including: - specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`) - MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`) - MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`) - MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`) To send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter. | [optional] +**EmailEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**Roles** | Pointer to **[]string** | List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role. | [optional] +**SmsEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**NotificationToken** | Pointer to **string** | HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**RoomName** | Pointer to **string** | HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". | [optional] +**MicrosoftTeamsWebhookUrl** | Pointer to **string** | Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted. | [optional] +**Severity** | Pointer to **string** | Degree of seriousness given to this notification. | [optional] +**OpsGenieApiKey** | Pointer to **string** | API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**OpsGenieRegion** | Pointer to **string** | Opsgenie region that indicates which API Uniform Resource Locator (URL) to use. | [optional] [default to "US"] +**Region** | Pointer to **string** | PagerDuty region that indicates which API Uniform Resource Locator (URL) to use. | [optional] [default to "US"] +**ServiceKey** | Pointer to **string** | PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**ApiToken** | Pointer to **string** | Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**ChannelName** | Pointer to **string** | Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. | [optional] +**MobileNumber** | Pointer to **string** | Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`. | [optional] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`. | [optional] +**TeamName** | Pointer to **string** | Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`. | [optional] +**Username** | Pointer to **string** | MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`. | [optional] +**VictorOpsApiKey** | Pointer to **string** | API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**VictorOpsRoutingKey** | Pointer to **string** | Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. | [optional] +**WebhookSecret** | Pointer to **string** | Authentication secret for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookSecret` to a non-empty string * You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted. | [optional] +**WebhookUrl** | Pointer to **string** | Target URL for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookURL` to a non-empty string * You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted. | [optional] + +## Methods + +### NewNotification + +`func NewNotification(typeName string, ) *Notification` + +NewNotification instantiates a new Notification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNotificationWithDefaults + +`func NewNotificationWithDefaults() *Notification` + +NewNotificationWithDefaults instantiates a new Notification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDatadogApiKey + +`func (o *Notification) GetDatadogApiKey() string` + +GetDatadogApiKey returns the DatadogApiKey field if non-nil, zero value otherwise. + +### GetDatadogApiKeyOk + +`func (o *Notification) GetDatadogApiKeyOk() (*string, bool)` + +GetDatadogApiKeyOk returns a tuple with the DatadogApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatadogApiKey + +`func (o *Notification) SetDatadogApiKey(v string)` + +SetDatadogApiKey sets DatadogApiKey field to given value. + +### HasDatadogApiKey + +`func (o *Notification) HasDatadogApiKey() bool` + +HasDatadogApiKey returns a boolean if a field has been set. + +### GetDatadogRegion + +`func (o *Notification) GetDatadogRegion() string` + +GetDatadogRegion returns the DatadogRegion field if non-nil, zero value otherwise. + +### GetDatadogRegionOk + +`func (o *Notification) GetDatadogRegionOk() (*string, bool)` + +GetDatadogRegionOk returns a tuple with the DatadogRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatadogRegion + +`func (o *Notification) SetDatadogRegion(v string)` + +SetDatadogRegion sets DatadogRegion field to given value. + +### HasDatadogRegion + +`func (o *Notification) HasDatadogRegion() bool` + +HasDatadogRegion returns a boolean if a field has been set. + +### GetDelayMin + +`func (o *Notification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *Notification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *Notification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *Notification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *Notification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *Notification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *Notification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *Notification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *Notification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *Notification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *Notification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + +### GetEmailAddress + +`func (o *Notification) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *Notification) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *Notification) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *Notification) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + +### GetEmailEnabled + +`func (o *Notification) GetEmailEnabled() bool` + +GetEmailEnabled returns the EmailEnabled field if non-nil, zero value otherwise. + +### GetEmailEnabledOk + +`func (o *Notification) GetEmailEnabledOk() (*bool, bool)` + +GetEmailEnabledOk returns a tuple with the EmailEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEnabled + +`func (o *Notification) SetEmailEnabled(v bool)` + +SetEmailEnabled sets EmailEnabled field to given value. + +### HasEmailEnabled + +`func (o *Notification) HasEmailEnabled() bool` + +HasEmailEnabled returns a boolean if a field has been set. + +### GetRoles + +`func (o *Notification) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *Notification) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *Notification) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *Notification) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetSmsEnabled + +`func (o *Notification) GetSmsEnabled() bool` + +GetSmsEnabled returns the SmsEnabled field if non-nil, zero value otherwise. + +### GetSmsEnabledOk + +`func (o *Notification) GetSmsEnabledOk() (*bool, bool)` + +GetSmsEnabledOk returns a tuple with the SmsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSmsEnabled + +`func (o *Notification) SetSmsEnabled(v bool)` + +SetSmsEnabled sets SmsEnabled field to given value. + +### HasSmsEnabled + +`func (o *Notification) HasSmsEnabled() bool` + +HasSmsEnabled returns a boolean if a field has been set. + +### GetNotificationToken + +`func (o *Notification) GetNotificationToken() string` + +GetNotificationToken returns the NotificationToken field if non-nil, zero value otherwise. + +### GetNotificationTokenOk + +`func (o *Notification) GetNotificationTokenOk() (*string, bool)` + +GetNotificationTokenOk returns a tuple with the NotificationToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationToken + +`func (o *Notification) SetNotificationToken(v string)` + +SetNotificationToken sets NotificationToken field to given value. + +### HasNotificationToken + +`func (o *Notification) HasNotificationToken() bool` + +HasNotificationToken returns a boolean if a field has been set. + +### GetRoomName + +`func (o *Notification) GetRoomName() string` + +GetRoomName returns the RoomName field if non-nil, zero value otherwise. + +### GetRoomNameOk + +`func (o *Notification) GetRoomNameOk() (*string, bool)` + +GetRoomNameOk returns a tuple with the RoomName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoomName + +`func (o *Notification) SetRoomName(v string)` + +SetRoomName sets RoomName field to given value. + +### HasRoomName + +`func (o *Notification) HasRoomName() bool` + +HasRoomName returns a boolean if a field has been set. + +### GetMicrosoftTeamsWebhookUrl + +`func (o *Notification) GetMicrosoftTeamsWebhookUrl() string` + +GetMicrosoftTeamsWebhookUrl returns the MicrosoftTeamsWebhookUrl field if non-nil, zero value otherwise. + +### GetMicrosoftTeamsWebhookUrlOk + +`func (o *Notification) GetMicrosoftTeamsWebhookUrlOk() (*string, bool)` + +GetMicrosoftTeamsWebhookUrlOk returns a tuple with the MicrosoftTeamsWebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMicrosoftTeamsWebhookUrl + +`func (o *Notification) SetMicrosoftTeamsWebhookUrl(v string)` + +SetMicrosoftTeamsWebhookUrl sets MicrosoftTeamsWebhookUrl field to given value. + +### HasMicrosoftTeamsWebhookUrl + +`func (o *Notification) HasMicrosoftTeamsWebhookUrl() bool` + +HasMicrosoftTeamsWebhookUrl returns a boolean if a field has been set. + +### GetSeverity + +`func (o *Notification) GetSeverity() string` + +GetSeverity returns the Severity field if non-nil, zero value otherwise. + +### GetSeverityOk + +`func (o *Notification) GetSeverityOk() (*string, bool)` + +GetSeverityOk returns a tuple with the Severity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSeverity + +`func (o *Notification) SetSeverity(v string)` + +SetSeverity sets Severity field to given value. + +### HasSeverity + +`func (o *Notification) HasSeverity() bool` + +HasSeverity returns a boolean if a field has been set. + +### GetOpsGenieApiKey + +`func (o *Notification) GetOpsGenieApiKey() string` + +GetOpsGenieApiKey returns the OpsGenieApiKey field if non-nil, zero value otherwise. + +### GetOpsGenieApiKeyOk + +`func (o *Notification) GetOpsGenieApiKeyOk() (*string, bool)` + +GetOpsGenieApiKeyOk returns a tuple with the OpsGenieApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpsGenieApiKey + +`func (o *Notification) SetOpsGenieApiKey(v string)` + +SetOpsGenieApiKey sets OpsGenieApiKey field to given value. + +### HasOpsGenieApiKey + +`func (o *Notification) HasOpsGenieApiKey() bool` + +HasOpsGenieApiKey returns a boolean if a field has been set. + +### GetOpsGenieRegion + +`func (o *Notification) GetOpsGenieRegion() string` + +GetOpsGenieRegion returns the OpsGenieRegion field if non-nil, zero value otherwise. + +### GetOpsGenieRegionOk + +`func (o *Notification) GetOpsGenieRegionOk() (*string, bool)` + +GetOpsGenieRegionOk returns a tuple with the OpsGenieRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpsGenieRegion + +`func (o *Notification) SetOpsGenieRegion(v string)` + +SetOpsGenieRegion sets OpsGenieRegion field to given value. + +### HasOpsGenieRegion + +`func (o *Notification) HasOpsGenieRegion() bool` + +HasOpsGenieRegion returns a boolean if a field has been set. + +### GetRegion + +`func (o *Notification) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *Notification) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *Notification) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *Notification) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetServiceKey + +`func (o *Notification) GetServiceKey() string` + +GetServiceKey returns the ServiceKey field if non-nil, zero value otherwise. + +### GetServiceKeyOk + +`func (o *Notification) GetServiceKeyOk() (*string, bool)` + +GetServiceKeyOk returns a tuple with the ServiceKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceKey + +`func (o *Notification) SetServiceKey(v string)` + +SetServiceKey sets ServiceKey field to given value. + +### HasServiceKey + +`func (o *Notification) HasServiceKey() bool` + +HasServiceKey returns a boolean if a field has been set. + +### GetApiToken + +`func (o *Notification) GetApiToken() string` + +GetApiToken returns the ApiToken field if non-nil, zero value otherwise. + +### GetApiTokenOk + +`func (o *Notification) GetApiTokenOk() (*string, bool)` + +GetApiTokenOk returns a tuple with the ApiToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiToken + +`func (o *Notification) SetApiToken(v string)` + +SetApiToken sets ApiToken field to given value. + +### HasApiToken + +`func (o *Notification) HasApiToken() bool` + +HasApiToken returns a boolean if a field has been set. + +### GetChannelName + +`func (o *Notification) GetChannelName() string` + +GetChannelName returns the ChannelName field if non-nil, zero value otherwise. + +### GetChannelNameOk + +`func (o *Notification) GetChannelNameOk() (*string, bool)` + +GetChannelNameOk returns a tuple with the ChannelName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChannelName + +`func (o *Notification) SetChannelName(v string)` + +SetChannelName sets ChannelName field to given value. + +### HasChannelName + +`func (o *Notification) HasChannelName() bool` + +HasChannelName returns a boolean if a field has been set. + +### GetMobileNumber + +`func (o *Notification) GetMobileNumber() string` + +GetMobileNumber returns the MobileNumber field if non-nil, zero value otherwise. + +### GetMobileNumberOk + +`func (o *Notification) GetMobileNumberOk() (*string, bool)` + +GetMobileNumberOk returns a tuple with the MobileNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMobileNumber + +`func (o *Notification) SetMobileNumber(v string)` + +SetMobileNumber sets MobileNumber field to given value. + +### HasMobileNumber + +`func (o *Notification) HasMobileNumber() bool` + +HasMobileNumber returns a boolean if a field has been set. + +### GetTeamId + +`func (o *Notification) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *Notification) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *Notification) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *Notification) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + +### GetTeamName + +`func (o *Notification) GetTeamName() string` + +GetTeamName returns the TeamName field if non-nil, zero value otherwise. + +### GetTeamNameOk + +`func (o *Notification) GetTeamNameOk() (*string, bool)` + +GetTeamNameOk returns a tuple with the TeamName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamName + +`func (o *Notification) SetTeamName(v string)` + +SetTeamName sets TeamName field to given value. + +### HasTeamName + +`func (o *Notification) HasTeamName() bool` + +HasTeamName returns a boolean if a field has been set. + +### GetUsername + +`func (o *Notification) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *Notification) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *Notification) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *Notification) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetVictorOpsApiKey + +`func (o *Notification) GetVictorOpsApiKey() string` + +GetVictorOpsApiKey returns the VictorOpsApiKey field if non-nil, zero value otherwise. + +### GetVictorOpsApiKeyOk + +`func (o *Notification) GetVictorOpsApiKeyOk() (*string, bool)` + +GetVictorOpsApiKeyOk returns a tuple with the VictorOpsApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVictorOpsApiKey + +`func (o *Notification) SetVictorOpsApiKey(v string)` + +SetVictorOpsApiKey sets VictorOpsApiKey field to given value. + +### HasVictorOpsApiKey + +`func (o *Notification) HasVictorOpsApiKey() bool` + +HasVictorOpsApiKey returns a boolean if a field has been set. + +### GetVictorOpsRoutingKey + +`func (o *Notification) GetVictorOpsRoutingKey() string` + +GetVictorOpsRoutingKey returns the VictorOpsRoutingKey field if non-nil, zero value otherwise. + +### GetVictorOpsRoutingKeyOk + +`func (o *Notification) GetVictorOpsRoutingKeyOk() (*string, bool)` + +GetVictorOpsRoutingKeyOk returns a tuple with the VictorOpsRoutingKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVictorOpsRoutingKey + +`func (o *Notification) SetVictorOpsRoutingKey(v string)` + +SetVictorOpsRoutingKey sets VictorOpsRoutingKey field to given value. + +### HasVictorOpsRoutingKey + +`func (o *Notification) HasVictorOpsRoutingKey() bool` + +HasVictorOpsRoutingKey returns a boolean if a field has been set. + +### GetWebhookSecret + +`func (o *Notification) GetWebhookSecret() string` + +GetWebhookSecret returns the WebhookSecret field if non-nil, zero value otherwise. + +### GetWebhookSecretOk + +`func (o *Notification) GetWebhookSecretOk() (*string, bool)` + +GetWebhookSecretOk returns a tuple with the WebhookSecret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWebhookSecret + +`func (o *Notification) SetWebhookSecret(v string)` + +SetWebhookSecret sets WebhookSecret field to given value. + +### HasWebhookSecret + +`func (o *Notification) HasWebhookSecret() bool` + +HasWebhookSecret returns a boolean if a field has been set. + +### GetWebhookUrl + +`func (o *Notification) GetWebhookUrl() string` + +GetWebhookUrl returns the WebhookUrl field if non-nil, zero value otherwise. + +### GetWebhookUrlOk + +`func (o *Notification) GetWebhookUrlOk() (*string, bool)` + +GetWebhookUrlOk returns a tuple with the WebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWebhookUrl + +`func (o *Notification) SetWebhookUrl(v string)` + +SetWebhookUrl sets WebhookUrl field to given value. + +### HasWebhookUrl + +`func (o *Notification) HasWebhookUrl() bool` + +HasWebhookUrl returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NotificationViewForNdsGroup.md b/docs/docs/NotificationViewForNdsGroup.md new file mode 100644 index 00000000..0bbd97d9 --- /dev/null +++ b/docs/docs/NotificationViewForNdsGroup.md @@ -0,0 +1,701 @@ +# NotificationViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DatadogApiKey** | Pointer to **string** | Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**DatadogRegion** | Pointer to **string** | Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`. To learn more about Datadog's regions, see <a href=\"https://docs.datadoghq.com/getting_started/site/\" target=\"_blank\" rel=\"noopener noreferrer\">Datadog Sites</a>. | [optional] [default to "US"] +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | +**EmailAddress** | Pointer to **string** | Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don’t need to set this value to send emails to individual or groups of MongoDB Cloud users including: - specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`) - MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`) - MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`) - MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`) To send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter. | [optional] +**EmailEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**Roles** | Pointer to **[]string** | List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role. | [optional] +**SmsEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**NotificationToken** | Pointer to **string** | HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**RoomName** | Pointer to **string** | HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". | [optional] +**MicrosoftTeamsWebhookUrl** | Pointer to **string** | Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted. | [optional] +**OpsGenieApiKey** | Pointer to **string** | API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**OpsGenieRegion** | Pointer to **string** | Opsgenie region that indicates which API Uniform Resource Locator (URL) to use. | [optional] [default to "US"] +**Region** | Pointer to **string** | PagerDuty region that indicates which API Uniform Resource Locator (URL) to use. | [optional] [default to "US"] +**ServiceKey** | Pointer to **string** | PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**ApiToken** | Pointer to **string** | Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**ChannelName** | Pointer to **string** | Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. | [optional] +**MobileNumber** | Pointer to **string** | Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`. | [optional] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`. | [optional] +**TeamName** | Pointer to **string** | Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`. | [optional] +**Username** | Pointer to **string** | MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`. | [optional] +**VictorOpsApiKey** | Pointer to **string** | API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**VictorOpsRoutingKey** | Pointer to **string** | Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. | [optional] +**WebhookSecret** | Pointer to **string** | Authentication secret for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookSecret` to a non-empty string * You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted. | [optional] +**WebhookUrl** | Pointer to **string** | Target URL for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookURL` to a non-empty string * You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted. | [optional] + +## Methods + +### NewNotificationViewForNdsGroup + +`func NewNotificationViewForNdsGroup(typeName string, ) *NotificationViewForNdsGroup` + +NewNotificationViewForNdsGroup instantiates a new NotificationViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNotificationViewForNdsGroupWithDefaults + +`func NewNotificationViewForNdsGroupWithDefaults() *NotificationViewForNdsGroup` + +NewNotificationViewForNdsGroupWithDefaults instantiates a new NotificationViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDatadogApiKey + +`func (o *NotificationViewForNdsGroup) GetDatadogApiKey() string` + +GetDatadogApiKey returns the DatadogApiKey field if non-nil, zero value otherwise. + +### GetDatadogApiKeyOk + +`func (o *NotificationViewForNdsGroup) GetDatadogApiKeyOk() (*string, bool)` + +GetDatadogApiKeyOk returns a tuple with the DatadogApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatadogApiKey + +`func (o *NotificationViewForNdsGroup) SetDatadogApiKey(v string)` + +SetDatadogApiKey sets DatadogApiKey field to given value. + +### HasDatadogApiKey + +`func (o *NotificationViewForNdsGroup) HasDatadogApiKey() bool` + +HasDatadogApiKey returns a boolean if a field has been set. + +### GetDatadogRegion + +`func (o *NotificationViewForNdsGroup) GetDatadogRegion() string` + +GetDatadogRegion returns the DatadogRegion field if non-nil, zero value otherwise. + +### GetDatadogRegionOk + +`func (o *NotificationViewForNdsGroup) GetDatadogRegionOk() (*string, bool)` + +GetDatadogRegionOk returns a tuple with the DatadogRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatadogRegion + +`func (o *NotificationViewForNdsGroup) SetDatadogRegion(v string)` + +SetDatadogRegion sets DatadogRegion field to given value. + +### HasDatadogRegion + +`func (o *NotificationViewForNdsGroup) HasDatadogRegion() bool` + +HasDatadogRegion returns a boolean if a field has been set. + +### GetDelayMin + +`func (o *NotificationViewForNdsGroup) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *NotificationViewForNdsGroup) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *NotificationViewForNdsGroup) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *NotificationViewForNdsGroup) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *NotificationViewForNdsGroup) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *NotificationViewForNdsGroup) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *NotificationViewForNdsGroup) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *NotificationViewForNdsGroup) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *NotificationViewForNdsGroup) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *NotificationViewForNdsGroup) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *NotificationViewForNdsGroup) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + +### GetEmailAddress + +`func (o *NotificationViewForNdsGroup) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *NotificationViewForNdsGroup) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *NotificationViewForNdsGroup) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *NotificationViewForNdsGroup) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + +### GetEmailEnabled + +`func (o *NotificationViewForNdsGroup) GetEmailEnabled() bool` + +GetEmailEnabled returns the EmailEnabled field if non-nil, zero value otherwise. + +### GetEmailEnabledOk + +`func (o *NotificationViewForNdsGroup) GetEmailEnabledOk() (*bool, bool)` + +GetEmailEnabledOk returns a tuple with the EmailEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEnabled + +`func (o *NotificationViewForNdsGroup) SetEmailEnabled(v bool)` + +SetEmailEnabled sets EmailEnabled field to given value. + +### HasEmailEnabled + +`func (o *NotificationViewForNdsGroup) HasEmailEnabled() bool` + +HasEmailEnabled returns a boolean if a field has been set. + +### GetRoles + +`func (o *NotificationViewForNdsGroup) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *NotificationViewForNdsGroup) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *NotificationViewForNdsGroup) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *NotificationViewForNdsGroup) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetSmsEnabled + +`func (o *NotificationViewForNdsGroup) GetSmsEnabled() bool` + +GetSmsEnabled returns the SmsEnabled field if non-nil, zero value otherwise. + +### GetSmsEnabledOk + +`func (o *NotificationViewForNdsGroup) GetSmsEnabledOk() (*bool, bool)` + +GetSmsEnabledOk returns a tuple with the SmsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSmsEnabled + +`func (o *NotificationViewForNdsGroup) SetSmsEnabled(v bool)` + +SetSmsEnabled sets SmsEnabled field to given value. + +### HasSmsEnabled + +`func (o *NotificationViewForNdsGroup) HasSmsEnabled() bool` + +HasSmsEnabled returns a boolean if a field has been set. + +### GetNotificationToken + +`func (o *NotificationViewForNdsGroup) GetNotificationToken() string` + +GetNotificationToken returns the NotificationToken field if non-nil, zero value otherwise. + +### GetNotificationTokenOk + +`func (o *NotificationViewForNdsGroup) GetNotificationTokenOk() (*string, bool)` + +GetNotificationTokenOk returns a tuple with the NotificationToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationToken + +`func (o *NotificationViewForNdsGroup) SetNotificationToken(v string)` + +SetNotificationToken sets NotificationToken field to given value. + +### HasNotificationToken + +`func (o *NotificationViewForNdsGroup) HasNotificationToken() bool` + +HasNotificationToken returns a boolean if a field has been set. + +### GetRoomName + +`func (o *NotificationViewForNdsGroup) GetRoomName() string` + +GetRoomName returns the RoomName field if non-nil, zero value otherwise. + +### GetRoomNameOk + +`func (o *NotificationViewForNdsGroup) GetRoomNameOk() (*string, bool)` + +GetRoomNameOk returns a tuple with the RoomName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoomName + +`func (o *NotificationViewForNdsGroup) SetRoomName(v string)` + +SetRoomName sets RoomName field to given value. + +### HasRoomName + +`func (o *NotificationViewForNdsGroup) HasRoomName() bool` + +HasRoomName returns a boolean if a field has been set. + +### GetMicrosoftTeamsWebhookUrl + +`func (o *NotificationViewForNdsGroup) GetMicrosoftTeamsWebhookUrl() string` + +GetMicrosoftTeamsWebhookUrl returns the MicrosoftTeamsWebhookUrl field if non-nil, zero value otherwise. + +### GetMicrosoftTeamsWebhookUrlOk + +`func (o *NotificationViewForNdsGroup) GetMicrosoftTeamsWebhookUrlOk() (*string, bool)` + +GetMicrosoftTeamsWebhookUrlOk returns a tuple with the MicrosoftTeamsWebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMicrosoftTeamsWebhookUrl + +`func (o *NotificationViewForNdsGroup) SetMicrosoftTeamsWebhookUrl(v string)` + +SetMicrosoftTeamsWebhookUrl sets MicrosoftTeamsWebhookUrl field to given value. + +### HasMicrosoftTeamsWebhookUrl + +`func (o *NotificationViewForNdsGroup) HasMicrosoftTeamsWebhookUrl() bool` + +HasMicrosoftTeamsWebhookUrl returns a boolean if a field has been set. + +### GetOpsGenieApiKey + +`func (o *NotificationViewForNdsGroup) GetOpsGenieApiKey() string` + +GetOpsGenieApiKey returns the OpsGenieApiKey field if non-nil, zero value otherwise. + +### GetOpsGenieApiKeyOk + +`func (o *NotificationViewForNdsGroup) GetOpsGenieApiKeyOk() (*string, bool)` + +GetOpsGenieApiKeyOk returns a tuple with the OpsGenieApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpsGenieApiKey + +`func (o *NotificationViewForNdsGroup) SetOpsGenieApiKey(v string)` + +SetOpsGenieApiKey sets OpsGenieApiKey field to given value. + +### HasOpsGenieApiKey + +`func (o *NotificationViewForNdsGroup) HasOpsGenieApiKey() bool` + +HasOpsGenieApiKey returns a boolean if a field has been set. + +### GetOpsGenieRegion + +`func (o *NotificationViewForNdsGroup) GetOpsGenieRegion() string` + +GetOpsGenieRegion returns the OpsGenieRegion field if non-nil, zero value otherwise. + +### GetOpsGenieRegionOk + +`func (o *NotificationViewForNdsGroup) GetOpsGenieRegionOk() (*string, bool)` + +GetOpsGenieRegionOk returns a tuple with the OpsGenieRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpsGenieRegion + +`func (o *NotificationViewForNdsGroup) SetOpsGenieRegion(v string)` + +SetOpsGenieRegion sets OpsGenieRegion field to given value. + +### HasOpsGenieRegion + +`func (o *NotificationViewForNdsGroup) HasOpsGenieRegion() bool` + +HasOpsGenieRegion returns a boolean if a field has been set. + +### GetRegion + +`func (o *NotificationViewForNdsGroup) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *NotificationViewForNdsGroup) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *NotificationViewForNdsGroup) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *NotificationViewForNdsGroup) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetServiceKey + +`func (o *NotificationViewForNdsGroup) GetServiceKey() string` + +GetServiceKey returns the ServiceKey field if non-nil, zero value otherwise. + +### GetServiceKeyOk + +`func (o *NotificationViewForNdsGroup) GetServiceKeyOk() (*string, bool)` + +GetServiceKeyOk returns a tuple with the ServiceKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceKey + +`func (o *NotificationViewForNdsGroup) SetServiceKey(v string)` + +SetServiceKey sets ServiceKey field to given value. + +### HasServiceKey + +`func (o *NotificationViewForNdsGroup) HasServiceKey() bool` + +HasServiceKey returns a boolean if a field has been set. + +### GetApiToken + +`func (o *NotificationViewForNdsGroup) GetApiToken() string` + +GetApiToken returns the ApiToken field if non-nil, zero value otherwise. + +### GetApiTokenOk + +`func (o *NotificationViewForNdsGroup) GetApiTokenOk() (*string, bool)` + +GetApiTokenOk returns a tuple with the ApiToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiToken + +`func (o *NotificationViewForNdsGroup) SetApiToken(v string)` + +SetApiToken sets ApiToken field to given value. + +### HasApiToken + +`func (o *NotificationViewForNdsGroup) HasApiToken() bool` + +HasApiToken returns a boolean if a field has been set. + +### GetChannelName + +`func (o *NotificationViewForNdsGroup) GetChannelName() string` + +GetChannelName returns the ChannelName field if non-nil, zero value otherwise. + +### GetChannelNameOk + +`func (o *NotificationViewForNdsGroup) GetChannelNameOk() (*string, bool)` + +GetChannelNameOk returns a tuple with the ChannelName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChannelName + +`func (o *NotificationViewForNdsGroup) SetChannelName(v string)` + +SetChannelName sets ChannelName field to given value. + +### HasChannelName + +`func (o *NotificationViewForNdsGroup) HasChannelName() bool` + +HasChannelName returns a boolean if a field has been set. + +### GetMobileNumber + +`func (o *NotificationViewForNdsGroup) GetMobileNumber() string` + +GetMobileNumber returns the MobileNumber field if non-nil, zero value otherwise. + +### GetMobileNumberOk + +`func (o *NotificationViewForNdsGroup) GetMobileNumberOk() (*string, bool)` + +GetMobileNumberOk returns a tuple with the MobileNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMobileNumber + +`func (o *NotificationViewForNdsGroup) SetMobileNumber(v string)` + +SetMobileNumber sets MobileNumber field to given value. + +### HasMobileNumber + +`func (o *NotificationViewForNdsGroup) HasMobileNumber() bool` + +HasMobileNumber returns a boolean if a field has been set. + +### GetTeamId + +`func (o *NotificationViewForNdsGroup) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *NotificationViewForNdsGroup) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *NotificationViewForNdsGroup) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *NotificationViewForNdsGroup) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + +### GetTeamName + +`func (o *NotificationViewForNdsGroup) GetTeamName() string` + +GetTeamName returns the TeamName field if non-nil, zero value otherwise. + +### GetTeamNameOk + +`func (o *NotificationViewForNdsGroup) GetTeamNameOk() (*string, bool)` + +GetTeamNameOk returns a tuple with the TeamName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamName + +`func (o *NotificationViewForNdsGroup) SetTeamName(v string)` + +SetTeamName sets TeamName field to given value. + +### HasTeamName + +`func (o *NotificationViewForNdsGroup) HasTeamName() bool` + +HasTeamName returns a boolean if a field has been set. + +### GetUsername + +`func (o *NotificationViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *NotificationViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *NotificationViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *NotificationViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetVictorOpsApiKey + +`func (o *NotificationViewForNdsGroup) GetVictorOpsApiKey() string` + +GetVictorOpsApiKey returns the VictorOpsApiKey field if non-nil, zero value otherwise. + +### GetVictorOpsApiKeyOk + +`func (o *NotificationViewForNdsGroup) GetVictorOpsApiKeyOk() (*string, bool)` + +GetVictorOpsApiKeyOk returns a tuple with the VictorOpsApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVictorOpsApiKey + +`func (o *NotificationViewForNdsGroup) SetVictorOpsApiKey(v string)` + +SetVictorOpsApiKey sets VictorOpsApiKey field to given value. + +### HasVictorOpsApiKey + +`func (o *NotificationViewForNdsGroup) HasVictorOpsApiKey() bool` + +HasVictorOpsApiKey returns a boolean if a field has been set. + +### GetVictorOpsRoutingKey + +`func (o *NotificationViewForNdsGroup) GetVictorOpsRoutingKey() string` + +GetVictorOpsRoutingKey returns the VictorOpsRoutingKey field if non-nil, zero value otherwise. + +### GetVictorOpsRoutingKeyOk + +`func (o *NotificationViewForNdsGroup) GetVictorOpsRoutingKeyOk() (*string, bool)` + +GetVictorOpsRoutingKeyOk returns a tuple with the VictorOpsRoutingKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVictorOpsRoutingKey + +`func (o *NotificationViewForNdsGroup) SetVictorOpsRoutingKey(v string)` + +SetVictorOpsRoutingKey sets VictorOpsRoutingKey field to given value. + +### HasVictorOpsRoutingKey + +`func (o *NotificationViewForNdsGroup) HasVictorOpsRoutingKey() bool` + +HasVictorOpsRoutingKey returns a boolean if a field has been set. + +### GetWebhookSecret + +`func (o *NotificationViewForNdsGroup) GetWebhookSecret() string` + +GetWebhookSecret returns the WebhookSecret field if non-nil, zero value otherwise. + +### GetWebhookSecretOk + +`func (o *NotificationViewForNdsGroup) GetWebhookSecretOk() (*string, bool)` + +GetWebhookSecretOk returns a tuple with the WebhookSecret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWebhookSecret + +`func (o *NotificationViewForNdsGroup) SetWebhookSecret(v string)` + +SetWebhookSecret sets WebhookSecret field to given value. + +### HasWebhookSecret + +`func (o *NotificationViewForNdsGroup) HasWebhookSecret() bool` + +HasWebhookSecret returns a boolean if a field has been set. + +### GetWebhookUrl + +`func (o *NotificationViewForNdsGroup) GetWebhookUrl() string` + +GetWebhookUrl returns the WebhookUrl field if non-nil, zero value otherwise. + +### GetWebhookUrlOk + +`func (o *NotificationViewForNdsGroup) GetWebhookUrlOk() (*string, bool)` + +GetWebhookUrlOk returns a tuple with the WebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWebhookUrl + +`func (o *NotificationViewForNdsGroup) SetWebhookUrl(v string)` + +SetWebhookUrl sets WebhookUrl field to given value. + +### HasWebhookUrl + +`func (o *NotificationViewForNdsGroup) HasWebhookUrl() bool` + +HasWebhookUrl returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NumberMetricAlert.md b/docs/docs/NumberMetricAlert.md new file mode 100644 index 00000000..0c01e093 --- /dev/null +++ b/docs/docs/NumberMetricAlert.md @@ -0,0 +1,489 @@ +# NumberMetricAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**NumberMetricValue**](NumberMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventTypeViewAlertable**](HostMetricEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see <a href=\"https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types\" target=\"_blank\">Host Metrics</a>. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href=\"https://dochub.mongodb.org/core/alert-config-serverless-measurements\" target=\"_blank\">Serverless Measurements</a>. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewNumberMetricAlert + +`func NewNumberMetricAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName HostMetricEventTypeViewAlertable, id string, status string, updated time.Time, ) *NumberMetricAlert` + +NewNumberMetricAlert instantiates a new NumberMetricAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNumberMetricAlertWithDefaults + +`func NewNumberMetricAlertWithDefaults() *NumberMetricAlert` + +NewNumberMetricAlertWithDefaults instantiates a new NumberMetricAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *NumberMetricAlert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *NumberMetricAlert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *NumberMetricAlert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *NumberMetricAlert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *NumberMetricAlert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *NumberMetricAlert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *NumberMetricAlert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *NumberMetricAlert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *NumberMetricAlert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *NumberMetricAlert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *NumberMetricAlert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *NumberMetricAlert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *NumberMetricAlert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *NumberMetricAlert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *NumberMetricAlert) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *NumberMetricAlert) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *NumberMetricAlert) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *NumberMetricAlert) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *NumberMetricAlert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NumberMetricAlert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NumberMetricAlert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *NumberMetricAlert) GetCurrentValue() NumberMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *NumberMetricAlert) GetCurrentValueOk() (*NumberMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *NumberMetricAlert) SetCurrentValue(v NumberMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *NumberMetricAlert) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *NumberMetricAlert) GetEventTypeName() HostMetricEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NumberMetricAlert) GetEventTypeNameOk() (*HostMetricEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NumberMetricAlert) SetEventTypeName(v HostMetricEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NumberMetricAlert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NumberMetricAlert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NumberMetricAlert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NumberMetricAlert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *NumberMetricAlert) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *NumberMetricAlert) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *NumberMetricAlert) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *NumberMetricAlert) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetId + +`func (o *NumberMetricAlert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NumberMetricAlert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NumberMetricAlert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *NumberMetricAlert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *NumberMetricAlert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *NumberMetricAlert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *NumberMetricAlert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *NumberMetricAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NumberMetricAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NumberMetricAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NumberMetricAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *NumberMetricAlert) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *NumberMetricAlert) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *NumberMetricAlert) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *NumberMetricAlert) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *NumberMetricAlert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *NumberMetricAlert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *NumberMetricAlert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *NumberMetricAlert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *NumberMetricAlert) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *NumberMetricAlert) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *NumberMetricAlert) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *NumberMetricAlert) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetResolved + +`func (o *NumberMetricAlert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *NumberMetricAlert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *NumberMetricAlert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *NumberMetricAlert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *NumberMetricAlert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NumberMetricAlert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NumberMetricAlert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *NumberMetricAlert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *NumberMetricAlert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *NumberMetricAlert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NumberMetricEvent.md b/docs/docs/NumberMetricEvent.md new file mode 100644 index 00000000..755aa0df --- /dev/null +++ b/docs/docs/NumberMetricEvent.md @@ -0,0 +1,483 @@ +# NumberMetricEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**NumberMetricValue**](NumberMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventType**](HostMetricEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewNumberMetricEvent + +`func NewNumberMetricEvent(created time.Time, eventTypeName HostMetricEventType, id string, ) *NumberMetricEvent` + +NewNumberMetricEvent instantiates a new NumberMetricEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNumberMetricEventWithDefaults + +`func NewNumberMetricEventWithDefaults() *NumberMetricEvent` + +NewNumberMetricEventWithDefaults instantiates a new NumberMetricEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *NumberMetricEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *NumberMetricEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *NumberMetricEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *NumberMetricEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NumberMetricEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NumberMetricEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NumberMetricEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *NumberMetricEvent) GetCurrentValue() NumberMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *NumberMetricEvent) GetCurrentValueOk() (*NumberMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *NumberMetricEvent) SetCurrentValue(v NumberMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *NumberMetricEvent) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *NumberMetricEvent) GetEventTypeName() HostMetricEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *NumberMetricEvent) GetEventTypeNameOk() (*HostMetricEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *NumberMetricEvent) SetEventTypeName(v HostMetricEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *NumberMetricEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *NumberMetricEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *NumberMetricEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *NumberMetricEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *NumberMetricEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NumberMetricEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NumberMetricEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *NumberMetricEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *NumberMetricEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *NumberMetricEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *NumberMetricEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *NumberMetricEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *NumberMetricEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *NumberMetricEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *NumberMetricEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *NumberMetricEvent) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *NumberMetricEvent) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *NumberMetricEvent) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *NumberMetricEvent) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *NumberMetricEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *NumberMetricEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *NumberMetricEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *NumberMetricEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPort + +`func (o *NumberMetricEvent) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *NumberMetricEvent) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *NumberMetricEvent) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *NumberMetricEvent) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *NumberMetricEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *NumberMetricEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *NumberMetricEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *NumberMetricEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *NumberMetricEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *NumberMetricEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *NumberMetricEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *NumberMetricEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *NumberMetricEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *NumberMetricEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *NumberMetricEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *NumberMetricEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *NumberMetricEvent) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *NumberMetricEvent) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *NumberMetricEvent) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *NumberMetricEvent) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *NumberMetricEvent) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *NumberMetricEvent) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *NumberMetricEvent) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *NumberMetricEvent) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetUserId + +`func (o *NumberMetricEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *NumberMetricEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *NumberMetricEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *NumberMetricEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *NumberMetricEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *NumberMetricEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *NumberMetricEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *NumberMetricEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NumberMetricThreshold.md b/docs/docs/NumberMetricThreshold.md new file mode 100644 index 00000000..09ab9973 --- /dev/null +++ b/docs/docs/NumberMetricThreshold.md @@ -0,0 +1,160 @@ +# NumberMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**NumberMetricUnits**](NumberMetricUnits.md) | | [optional] + +## Methods + +### NewNumberMetricThreshold + +`func NewNumberMetricThreshold() *NumberMetricThreshold` + +NewNumberMetricThreshold instantiates a new NumberMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNumberMetricThresholdWithDefaults + +`func NewNumberMetricThresholdWithDefaults() *NumberMetricThreshold` + +NewNumberMetricThresholdWithDefaults instantiates a new NumberMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *NumberMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *NumberMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *NumberMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *NumberMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *NumberMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *NumberMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *NumberMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *NumberMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *NumberMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *NumberMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *NumberMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *NumberMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *NumberMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *NumberMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *NumberMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *NumberMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *NumberMetricThreshold) GetUnits() NumberMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *NumberMetricThreshold) GetUnitsOk() (*NumberMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *NumberMetricThreshold) SetUnits(v NumberMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *NumberMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NumberMetricUnits.md b/docs/docs/NumberMetricUnits.md new file mode 100644 index 00000000..ec3ce26d --- /dev/null +++ b/docs/docs/NumberMetricUnits.md @@ -0,0 +1,17 @@ +# NumberMetricUnits + +## Enum + + +* `COUNT` (value: `"COUNT"`) + +* `THOUSAND` (value: `"THOUSAND"`) + +* `MILLION` (value: `"MILLION"`) + +* `BILLION` (value: `"BILLION"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/NumberMetricValue.md b/docs/docs/NumberMetricValue.md new file mode 100644 index 00000000..ad20a641 --- /dev/null +++ b/docs/docs/NumberMetricValue.md @@ -0,0 +1,82 @@ +# NumberMetricValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **float64** | Amount of the **metricName** recorded at the time of the event. This value triggered the alert. | [optional] [readonly] +**Units** | Pointer to [**NumberMetricUnits**](NumberMetricUnits.md) | | [optional] + +## Methods + +### NewNumberMetricValue + +`func NewNumberMetricValue() *NumberMetricValue` + +NewNumberMetricValue instantiates a new NumberMetricValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNumberMetricValueWithDefaults + +`func NewNumberMetricValueWithDefaults() *NumberMetricValue` + +NewNumberMetricValueWithDefaults instantiates a new NumberMetricValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *NumberMetricValue) GetNumber() float64` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *NumberMetricValue) GetNumberOk() (*float64, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *NumberMetricValue) SetNumber(v float64)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *NumberMetricValue) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetUnits + +`func (o *NumberMetricValue) GetUnits() NumberMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *NumberMetricValue) GetUnitsOk() (*NumberMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *NumberMetricValue) SetUnits(v NumberMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *NumberMetricValue) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OnDemandCpsSnapshotSource.md b/docs/docs/OnDemandCpsSnapshotSource.md new file mode 100644 index 00000000..f5ce5061 --- /dev/null +++ b/docs/docs/OnDemandCpsSnapshotSource.md @@ -0,0 +1,160 @@ +# OnDemandCpsSnapshotSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | Pointer to **string** | Human-readable name that identifies the cluster. | [optional] +**CollectionName** | Pointer to **string** | Human-readable name that identifies the collection. | [optional] +**DatabaseName** | Pointer to **string** | Human-readable name that identifies the database. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**Type** | Pointer to **string** | Type of ingestion source of this Data Lake Pipeline. | [optional] + +## Methods + +### NewOnDemandCpsSnapshotSource + +`func NewOnDemandCpsSnapshotSource() *OnDemandCpsSnapshotSource` + +NewOnDemandCpsSnapshotSource instantiates a new OnDemandCpsSnapshotSource object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOnDemandCpsSnapshotSourceWithDefaults + +`func NewOnDemandCpsSnapshotSourceWithDefaults() *OnDemandCpsSnapshotSource` + +NewOnDemandCpsSnapshotSourceWithDefaults instantiates a new OnDemandCpsSnapshotSource object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *OnDemandCpsSnapshotSource) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *OnDemandCpsSnapshotSource) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *OnDemandCpsSnapshotSource) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *OnDemandCpsSnapshotSource) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCollectionName + +`func (o *OnDemandCpsSnapshotSource) GetCollectionName() string` + +GetCollectionName returns the CollectionName field if non-nil, zero value otherwise. + +### GetCollectionNameOk + +`func (o *OnDemandCpsSnapshotSource) GetCollectionNameOk() (*string, bool)` + +GetCollectionNameOk returns a tuple with the CollectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionName + +`func (o *OnDemandCpsSnapshotSource) SetCollectionName(v string)` + +SetCollectionName sets CollectionName field to given value. + +### HasCollectionName + +`func (o *OnDemandCpsSnapshotSource) HasCollectionName() bool` + +HasCollectionName returns a boolean if a field has been set. + +### GetDatabaseName + +`func (o *OnDemandCpsSnapshotSource) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *OnDemandCpsSnapshotSource) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *OnDemandCpsSnapshotSource) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + +### HasDatabaseName + +`func (o *OnDemandCpsSnapshotSource) HasDatabaseName() bool` + +HasDatabaseName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *OnDemandCpsSnapshotSource) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *OnDemandCpsSnapshotSource) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *OnDemandCpsSnapshotSource) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *OnDemandCpsSnapshotSource) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetType + +`func (o *OnDemandCpsSnapshotSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OnDemandCpsSnapshotSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OnDemandCpsSnapshotSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OnDemandCpsSnapshotSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OnlineArchive.md b/docs/docs/OnlineArchive.md new file mode 100644 index 00000000..193ec056 --- /dev/null +++ b/docs/docs/OnlineArchive.md @@ -0,0 +1,290 @@ +# OnlineArchive + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the online archive. | [optional] [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive. | [optional] [readonly] +**CollName** | Pointer to **string** | Human-readable label that identifies the collection for which you created the online archive. | [optional] +**CollectionType** | Pointer to **string** | Classification of MongoDB database collection that you want to return. If you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`. | [optional] [default to "STANDARD"] +**Criteria** | Pointer to [**Criteria**](Criteria.md) | | [optional] +**DbName** | Pointer to **string** | Human-readable label of the database that contains the collection that contains the online archive. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive. | [optional] [readonly] +**PartitionFields** | Pointer to [**[]PartitionField**](PartitionField.md) | List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs. | [optional] +**Schedule** | Pointer to [**OnlineArchiveSchedule**](OnlineArchiveSchedule.md) | | [optional] +**State** | Pointer to **string** | Phase of the process to create this online archive when you made this request. | State | Indication | |-------------|------------| | `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. | | `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. | | `IDLE` | MongoDB Cloud waits to start the next archival job. | | `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. | | `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. | | `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. | | `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. | | [optional] [readonly] + +## Methods + +### NewOnlineArchive + +`func NewOnlineArchive() *OnlineArchive` + +NewOnlineArchive instantiates a new OnlineArchive object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOnlineArchiveWithDefaults + +`func NewOnlineArchiveWithDefaults() *OnlineArchive` + +NewOnlineArchiveWithDefaults instantiates a new OnlineArchive object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *OnlineArchive) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OnlineArchive) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OnlineArchive) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OnlineArchive) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetClusterName + +`func (o *OnlineArchive) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *OnlineArchive) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *OnlineArchive) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *OnlineArchive) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCollName + +`func (o *OnlineArchive) GetCollName() string` + +GetCollName returns the CollName field if non-nil, zero value otherwise. + +### GetCollNameOk + +`func (o *OnlineArchive) GetCollNameOk() (*string, bool)` + +GetCollNameOk returns a tuple with the CollName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollName + +`func (o *OnlineArchive) SetCollName(v string)` + +SetCollName sets CollName field to given value. + +### HasCollName + +`func (o *OnlineArchive) HasCollName() bool` + +HasCollName returns a boolean if a field has been set. + +### GetCollectionType + +`func (o *OnlineArchive) GetCollectionType() string` + +GetCollectionType returns the CollectionType field if non-nil, zero value otherwise. + +### GetCollectionTypeOk + +`func (o *OnlineArchive) GetCollectionTypeOk() (*string, bool)` + +GetCollectionTypeOk returns a tuple with the CollectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionType + +`func (o *OnlineArchive) SetCollectionType(v string)` + +SetCollectionType sets CollectionType field to given value. + +### HasCollectionType + +`func (o *OnlineArchive) HasCollectionType() bool` + +HasCollectionType returns a boolean if a field has been set. + +### GetCriteria + +`func (o *OnlineArchive) GetCriteria() Criteria` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *OnlineArchive) GetCriteriaOk() (*Criteria, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *OnlineArchive) SetCriteria(v Criteria)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *OnlineArchive) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### GetDbName + +`func (o *OnlineArchive) GetDbName() string` + +GetDbName returns the DbName field if non-nil, zero value otherwise. + +### GetDbNameOk + +`func (o *OnlineArchive) GetDbNameOk() (*string, bool)` + +GetDbNameOk returns a tuple with the DbName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDbName + +`func (o *OnlineArchive) SetDbName(v string)` + +SetDbName sets DbName field to given value. + +### HasDbName + +`func (o *OnlineArchive) HasDbName() bool` + +HasDbName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *OnlineArchive) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *OnlineArchive) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *OnlineArchive) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *OnlineArchive) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetPartitionFields + +`func (o *OnlineArchive) GetPartitionFields() []PartitionField` + +GetPartitionFields returns the PartitionFields field if non-nil, zero value otherwise. + +### GetPartitionFieldsOk + +`func (o *OnlineArchive) GetPartitionFieldsOk() (*[]PartitionField, bool)` + +GetPartitionFieldsOk returns a tuple with the PartitionFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartitionFields + +`func (o *OnlineArchive) SetPartitionFields(v []PartitionField)` + +SetPartitionFields sets PartitionFields field to given value. + +### HasPartitionFields + +`func (o *OnlineArchive) HasPartitionFields() bool` + +HasPartitionFields returns a boolean if a field has been set. + +### GetSchedule + +`func (o *OnlineArchive) GetSchedule() OnlineArchiveSchedule` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *OnlineArchive) GetScheduleOk() (*OnlineArchiveSchedule, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *OnlineArchive) SetSchedule(v OnlineArchiveSchedule)` + +SetSchedule sets Schedule field to given value. + +### HasSchedule + +`func (o *OnlineArchive) HasSchedule() bool` + +HasSchedule returns a boolean if a field has been set. + +### GetState + +`func (o *OnlineArchive) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *OnlineArchive) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *OnlineArchive) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *OnlineArchive) HasState() bool` + +HasState returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OnlineArchiveApi.md b/docs/docs/OnlineArchiveApi.md new file mode 100644 index 00000000..b373ef0b --- /dev/null +++ b/docs/docs/OnlineArchiveApi.md @@ -0,0 +1,499 @@ +# \OnlineArchiveApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateOnlineArchive**](OnlineArchiveApi.md#CreateOnlineArchive) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives | Create One Online Archive +[**DeleteOnlineArchive**](OnlineArchiveApi.md#DeleteOnlineArchive) | **Delete** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} | Remove One Online Archive +[**DownloadOnlineArchiveQueryLogs**](OnlineArchiveApi.md#DownloadOnlineArchiveQueryLogs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz | Download Online Archive Query Logs +[**GetOnlineArchive**](OnlineArchiveApi.md#GetOnlineArchive) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} | Return One Online Archive +[**ListOnlineArchives**](OnlineArchiveApi.md#ListOnlineArchives) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives | Return All Online Archives for One Cluster +[**UpdateOnlineArchive**](OnlineArchiveApi.md#UpdateOnlineArchive) | **Patch** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} | Update One Online Archive + + + +## CreateOnlineArchive + +> OnlineArchive CreateOnlineArchive(ctx, groupId, clusterName).OnlineArchive(onlineArchive).Execute() + +Create One Online Archive + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + onlineArchive := *openapiclient.NewOnlineArchive() // OnlineArchive | + + resp, r, err := sdk.OnlineArchiveApi.CreateOnlineArchive(context.Background(), groupId, clusterName).OnlineArchive(onlineArchive).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OnlineArchiveApi.CreateOnlineArchive``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateOnlineArchive`: OnlineArchive + fmt.Fprintf(os.Stdout, "Response from `OnlineArchiveApi.CreateOnlineArchive`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOnlineArchiveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **onlineArchive** | [**OnlineArchive**](OnlineArchive.md) | Creates one online archive. | + +### Return type + +[**OnlineArchive**](OnlineArchive.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteOnlineArchive + +> DeleteOnlineArchive(ctx, groupId, archiveId, clusterName).Execute() + +Remove One Online Archive + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + archiveId := "archiveId_example" // string | + clusterName := "clusterName_example" // string | + + r, err := sdk.OnlineArchiveApi.DeleteOnlineArchive(context.Background(), groupId, archiveId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OnlineArchiveApi.DeleteOnlineArchive``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**archiveId** | **string** | Unique 24-hexadecimal digit string that identifies the online archive to delete. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOnlineArchiveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DownloadOnlineArchiveQueryLogs + +> *os.File DownloadOnlineArchiveQueryLogs(ctx, groupId, clusterName).StartDate(startDate).EndDate(endDate).ArchiveOnly(archiveOnly).Execute() + +Download Online Archive Query Logs + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + startDate := int64(1636481348) // int64 | (optional) + endDate := int64(1636481348) // int64 | (optional) + archiveOnly := true // bool | (optional) (default to false) + + resp, r, err := sdk.OnlineArchiveApi.DownloadOnlineArchiveQueryLogs(context.Background(), groupId, clusterName).StartDate(startDate).EndDate(endDate).ArchiveOnly(archiveOnly).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OnlineArchiveApi.DownloadOnlineArchiveQueryLogs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DownloadOnlineArchiveQueryLogs`: *os.File + fmt.Fprintf(os.Stdout, "Response from `OnlineArchiveApi.DownloadOnlineArchiveQueryLogs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadOnlineArchiveQueryLogsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **startDate** | **int64** | Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). | + **endDate** | **int64** | Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). | + **archiveOnly** | **bool** | Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. | [default to false] + +### Return type + +[***os.File**](*os.File.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+gzip, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOnlineArchive + +> OnlineArchive GetOnlineArchive(ctx, groupId, archiveId, clusterName).Execute() + +Return One Online Archive + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + archiveId := "archiveId_example" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.OnlineArchiveApi.GetOnlineArchive(context.Background(), groupId, archiveId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OnlineArchiveApi.GetOnlineArchive``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetOnlineArchive`: OnlineArchive + fmt.Fprintf(os.Stdout, "Response from `OnlineArchiveApi.GetOnlineArchive`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**archiveId** | **string** | Unique 24-hexadecimal digit string that identifies the online archive to return. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOnlineArchiveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**OnlineArchive**](OnlineArchive.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListOnlineArchives + +> PaginatedOnlineArchive ListOnlineArchives(ctx, groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Online Archives for One Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.OnlineArchiveApi.ListOnlineArchives(context.Background(), groupId, clusterName).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OnlineArchiveApi.ListOnlineArchives``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListOnlineArchives`: PaginatedOnlineArchive + fmt.Fprintf(os.Stdout, "Response from `OnlineArchiveApi.ListOnlineArchives`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOnlineArchivesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedOnlineArchive**](PaginatedOnlineArchive.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateOnlineArchive + +> OnlineArchive UpdateOnlineArchive(ctx, groupId, archiveId, clusterName).OnlineArchive(onlineArchive).Execute() + +Update One Online Archive + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + archiveId := "archiveId_example" // string | + clusterName := "clusterName_example" // string | + onlineArchive := *openapiclient.NewOnlineArchive() // OnlineArchive | + + resp, r, err := sdk.OnlineArchiveApi.UpdateOnlineArchive(context.Background(), groupId, archiveId, clusterName).OnlineArchive(onlineArchive).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OnlineArchiveApi.UpdateOnlineArchive``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateOnlineArchive`: OnlineArchive + fmt.Fprintf(os.Stdout, "Response from `OnlineArchiveApi.UpdateOnlineArchive`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**archiveId** | **string** | Unique 24-hexadecimal digit string that identifies the online archive to update. | +**clusterName** | **string** | Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateOnlineArchiveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **onlineArchive** | [**OnlineArchive**](OnlineArchive.md) | Updates, pauses, or resumes one online archive. | + +### Return type + +[**OnlineArchive**](OnlineArchive.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/OnlineArchiveSchedule.md b/docs/docs/OnlineArchiveSchedule.md new file mode 100644 index 00000000..a35d488d --- /dev/null +++ b/docs/docs/OnlineArchiveSchedule.md @@ -0,0 +1,207 @@ +# OnlineArchiveSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | | +**EndHour** | Pointer to **int** | Hour of the day when the scheduled window to run one online archive ends. | [optional] +**EndMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive ends. | [optional] +**StartHour** | Pointer to **int** | Hour of the day when the when the scheduled window to run one online archive starts. | [optional] +**StartMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive starts. | [optional] +**DayOfWeek** | Pointer to **int** | Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`). | [optional] +**DayOfMonth** | Pointer to **int** | Day of the month when the scheduled archive starts. | [optional] + +## Methods + +### NewOnlineArchiveSchedule + +`func NewOnlineArchiveSchedule(type_ string, ) *OnlineArchiveSchedule` + +NewOnlineArchiveSchedule instantiates a new OnlineArchiveSchedule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOnlineArchiveScheduleWithDefaults + +`func NewOnlineArchiveScheduleWithDefaults() *OnlineArchiveSchedule` + +NewOnlineArchiveScheduleWithDefaults instantiates a new OnlineArchiveSchedule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *OnlineArchiveSchedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OnlineArchiveSchedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OnlineArchiveSchedule) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEndHour + +`func (o *OnlineArchiveSchedule) GetEndHour() int` + +GetEndHour returns the EndHour field if non-nil, zero value otherwise. + +### GetEndHourOk + +`func (o *OnlineArchiveSchedule) GetEndHourOk() (*int, bool)` + +GetEndHourOk returns a tuple with the EndHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndHour + +`func (o *OnlineArchiveSchedule) SetEndHour(v int)` + +SetEndHour sets EndHour field to given value. + +### HasEndHour + +`func (o *OnlineArchiveSchedule) HasEndHour() bool` + +HasEndHour returns a boolean if a field has been set. + +### GetEndMinute + +`func (o *OnlineArchiveSchedule) GetEndMinute() int` + +GetEndMinute returns the EndMinute field if non-nil, zero value otherwise. + +### GetEndMinuteOk + +`func (o *OnlineArchiveSchedule) GetEndMinuteOk() (*int, bool)` + +GetEndMinuteOk returns a tuple with the EndMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndMinute + +`func (o *OnlineArchiveSchedule) SetEndMinute(v int)` + +SetEndMinute sets EndMinute field to given value. + +### HasEndMinute + +`func (o *OnlineArchiveSchedule) HasEndMinute() bool` + +HasEndMinute returns a boolean if a field has been set. + +### GetStartHour + +`func (o *OnlineArchiveSchedule) GetStartHour() int` + +GetStartHour returns the StartHour field if non-nil, zero value otherwise. + +### GetStartHourOk + +`func (o *OnlineArchiveSchedule) GetStartHourOk() (*int, bool)` + +GetStartHourOk returns a tuple with the StartHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartHour + +`func (o *OnlineArchiveSchedule) SetStartHour(v int)` + +SetStartHour sets StartHour field to given value. + +### HasStartHour + +`func (o *OnlineArchiveSchedule) HasStartHour() bool` + +HasStartHour returns a boolean if a field has been set. + +### GetStartMinute + +`func (o *OnlineArchiveSchedule) GetStartMinute() int` + +GetStartMinute returns the StartMinute field if non-nil, zero value otherwise. + +### GetStartMinuteOk + +`func (o *OnlineArchiveSchedule) GetStartMinuteOk() (*int, bool)` + +GetStartMinuteOk returns a tuple with the StartMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartMinute + +`func (o *OnlineArchiveSchedule) SetStartMinute(v int)` + +SetStartMinute sets StartMinute field to given value. + +### HasStartMinute + +`func (o *OnlineArchiveSchedule) HasStartMinute() bool` + +HasStartMinute returns a boolean if a field has been set. + +### GetDayOfWeek + +`func (o *OnlineArchiveSchedule) GetDayOfWeek() int` + +GetDayOfWeek returns the DayOfWeek field if non-nil, zero value otherwise. + +### GetDayOfWeekOk + +`func (o *OnlineArchiveSchedule) GetDayOfWeekOk() (*int, bool)` + +GetDayOfWeekOk returns a tuple with the DayOfWeek field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDayOfWeek + +`func (o *OnlineArchiveSchedule) SetDayOfWeek(v int)` + +SetDayOfWeek sets DayOfWeek field to given value. + +### HasDayOfWeek + +`func (o *OnlineArchiveSchedule) HasDayOfWeek() bool` + +HasDayOfWeek returns a boolean if a field has been set. + +### GetDayOfMonth + +`func (o *OnlineArchiveSchedule) GetDayOfMonth() int` + +GetDayOfMonth returns the DayOfMonth field if non-nil, zero value otherwise. + +### GetDayOfMonthOk + +`func (o *OnlineArchiveSchedule) GetDayOfMonthOk() (*int, bool)` + +GetDayOfMonthOk returns a tuple with the DayOfMonth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDayOfMonth + +`func (o *OnlineArchiveSchedule) SetDayOfMonth(v int)` + +SetDayOfMonth sets DayOfMonth field to given value. + +### HasDayOfMonth + +`func (o *OnlineArchiveSchedule) HasDayOfMonth() bool` + +HasDayOfMonth returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Operator.md b/docs/docs/Operator.md new file mode 100644 index 00000000..6e387a7a --- /dev/null +++ b/docs/docs/Operator.md @@ -0,0 +1,13 @@ +# Operator + +## Enum + + +* `LESS_THAN` (value: `"<"`) + +* `GREATER_THAN` (value: `">"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OpsGenie.md b/docs/docs/OpsGenie.md new file mode 100644 index 00000000..b488fded --- /dev/null +++ b/docs/docs/OpsGenie.md @@ -0,0 +1,103 @@ +# OpsGenie + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | **string** | Key that allows MongoDB Cloud to access your Opsgenie account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | +**Region** | Pointer to **string** | Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API. | [optional] [default to "US"] +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] + +## Methods + +### NewOpsGenie + +`func NewOpsGenie(apiKey string, ) *OpsGenie` + +NewOpsGenie instantiates a new OpsGenie object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOpsGenieWithDefaults + +`func NewOpsGenieWithDefaults() *OpsGenie` + +NewOpsGenieWithDefaults instantiates a new OpsGenie object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKey + +`func (o *OpsGenie) GetApiKey() string` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *OpsGenie) GetApiKeyOk() (*string, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *OpsGenie) SetApiKey(v string)` + +SetApiKey sets ApiKey field to given value. + + +### GetRegion + +`func (o *OpsGenie) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *OpsGenie) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *OpsGenie) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *OpsGenie) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetType + +`func (o *OpsGenie) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OpsGenie) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OpsGenie) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OpsGenie) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OpsGenieNotification.md b/docs/docs/OpsGenieNotification.md new file mode 100644 index 00000000..03ef6445 --- /dev/null +++ b/docs/docs/OpsGenieNotification.md @@ -0,0 +1,155 @@ +# OpsGenieNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**OpsGenieApiKey** | Pointer to **string** | API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**OpsGenieRegion** | Pointer to **string** | Opsgenie region that indicates which API Uniform Resource Locator (URL) to use. | [optional] [default to "US"] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewOpsGenieNotification + +`func NewOpsGenieNotification(typeName string, ) *OpsGenieNotification` + +NewOpsGenieNotification instantiates a new OpsGenieNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOpsGenieNotificationWithDefaults + +`func NewOpsGenieNotificationWithDefaults() *OpsGenieNotification` + +NewOpsGenieNotificationWithDefaults instantiates a new OpsGenieNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *OpsGenieNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *OpsGenieNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *OpsGenieNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *OpsGenieNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *OpsGenieNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *OpsGenieNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *OpsGenieNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *OpsGenieNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetOpsGenieApiKey + +`func (o *OpsGenieNotification) GetOpsGenieApiKey() string` + +GetOpsGenieApiKey returns the OpsGenieApiKey field if non-nil, zero value otherwise. + +### GetOpsGenieApiKeyOk + +`func (o *OpsGenieNotification) GetOpsGenieApiKeyOk() (*string, bool)` + +GetOpsGenieApiKeyOk returns a tuple with the OpsGenieApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpsGenieApiKey + +`func (o *OpsGenieNotification) SetOpsGenieApiKey(v string)` + +SetOpsGenieApiKey sets OpsGenieApiKey field to given value. + +### HasOpsGenieApiKey + +`func (o *OpsGenieNotification) HasOpsGenieApiKey() bool` + +HasOpsGenieApiKey returns a boolean if a field has been set. + +### GetOpsGenieRegion + +`func (o *OpsGenieNotification) GetOpsGenieRegion() string` + +GetOpsGenieRegion returns the OpsGenieRegion field if non-nil, zero value otherwise. + +### GetOpsGenieRegionOk + +`func (o *OpsGenieNotification) GetOpsGenieRegionOk() (*string, bool)` + +GetOpsGenieRegionOk returns a tuple with the OpsGenieRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpsGenieRegion + +`func (o *OpsGenieNotification) SetOpsGenieRegion(v string)` + +SetOpsGenieRegion sets OpsGenieRegion field to given value. + +### HasOpsGenieRegion + +`func (o *OpsGenieNotification) HasOpsGenieRegion() bool` + +HasOpsGenieRegion returns a boolean if a field has been set. + +### GetTypeName + +`func (o *OpsGenieNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *OpsGenieNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *OpsGenieNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrgEventTypeViewForOrg.md b/docs/docs/OrgEventTypeViewForOrg.md new file mode 100644 index 00000000..dc30cc6e --- /dev/null +++ b/docs/docs/OrgEventTypeViewForOrg.md @@ -0,0 +1,97 @@ +# OrgEventTypeViewForOrg + +## Enum + + +* `ORG_CREATED` (value: `"ORG_CREATED"`) + +* `ORG_CREDIT_CARD_ADDED` (value: `"ORG_CREDIT_CARD_ADDED"`) + +* `ORG_CREDIT_CARD_UPDATED` (value: `"ORG_CREDIT_CARD_UPDATED"`) + +* `ORG_CREDIT_CARD_CURRENT` (value: `"ORG_CREDIT_CARD_CURRENT"`) + +* `ORG_CREDIT_CARD_ABOUT_TO_EXPIRE` (value: `"ORG_CREDIT_CARD_ABOUT_TO_EXPIRE"`) + +* `ORG_PAYPAL_LINKED` (value: `"ORG_PAYPAL_LINKED"`) + +* `ORG_PAYPAL_UPDATED` (value: `"ORG_PAYPAL_UPDATED"`) + +* `ORG_PAYPAL_CANCELLED` (value: `"ORG_PAYPAL_CANCELLED"`) + +* `ORG_OVERRIDE_PAYMENT_METHOD_ADDED` (value: `"ORG_OVERRIDE_PAYMENT_METHOD_ADDED"`) + +* `ORG_ACTIVATED` (value: `"ORG_ACTIVATED"`) + +* `ORG_TEMPORARILY_ACTIVATED` (value: `"ORG_TEMPORARILY_ACTIVATED"`) + +* `ORG_SUSPENDED` (value: `"ORG_SUSPENDED"`) + +* `ORG_ADMIN_SUSPENDED` (value: `"ORG_ADMIN_SUSPENDED"`) + +* `ORG_ADMIN_LOCKED` (value: `"ORG_ADMIN_LOCKED"`) + +* `ORG_CLUSTERS_DELETED` (value: `"ORG_CLUSTERS_DELETED"`) + +* `ORG_CLUSTERS_PAUSED` (value: `"ORG_CLUSTERS_PAUSED"`) + +* `ORG_LOCKED` (value: `"ORG_LOCKED"`) + +* `ORG_RENAMED` (value: `"ORG_RENAMED"`) + +* `ALL_ORG_USERS_HAVE_MFA` (value: `"ALL_ORG_USERS_HAVE_MFA"`) + +* `ORG_USERS_WITHOUT_MFA` (value: `"ORG_USERS_WITHOUT_MFA"`) + +* `ORG_INVOICE_UNDER_THRESHOLD` (value: `"ORG_INVOICE_UNDER_THRESHOLD"`) + +* `ORG_INVOICE_OVER_THRESHOLD` (value: `"ORG_INVOICE_OVER_THRESHOLD"`) + +* `ORG_DAILY_BILL_UNDER_THRESHOLD` (value: `"ORG_DAILY_BILL_UNDER_THRESHOLD"`) + +* `ORG_DAILY_BILL_OVER_THRESHOLD` (value: `"ORG_DAILY_BILL_OVER_THRESHOLD"`) + +* `ORG_GROUP_CHARGES_UNDER_THRESHOLD` (value: `"ORG_GROUP_CHARGES_UNDER_THRESHOLD"`) + +* `ORG_GROUP_CHARGES_OVER_THRESHOLD` (value: `"ORG_GROUP_CHARGES_OVER_THRESHOLD"`) + +* `ORG_TWO_FACTOR_AUTH_REQUIRED` (value: `"ORG_TWO_FACTOR_AUTH_REQUIRED"`) + +* `ORG_TWO_FACTOR_AUTH_OPTIONAL` (value: `"ORG_TWO_FACTOR_AUTH_OPTIONAL"`) + +* `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` (value: `"ORG_PUBLIC_API_ACCESS_LIST_REQUIRED"`) + +* `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` (value: `"ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED"`) + +* `ORG_EMPLOYEE_ACCESS_RESTRICTED` (value: `"ORG_EMPLOYEE_ACCESS_RESTRICTED"`) + +* `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` (value: `"ORG_EMPLOYEE_ACCESS_UNRESTRICTED"`) + +* `ORG_SFDC_ACCOUNT_ID_CHANGED` (value: `"ORG_SFDC_ACCOUNT_ID_CHANGED"`) + +* `ORG_CONNECTED_TO_MLAB` (value: `"ORG_CONNECTED_TO_MLAB"`) + +* `ORG_DISCONNECTED_FROM_MLAB` (value: `"ORG_DISCONNECTED_FROM_MLAB"`) + +* `ORG_IDP_CERTIFICATE_CURRENT` (value: `"ORG_IDP_CERTIFICATE_CURRENT"`) + +* `ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE` (value: `"ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE"`) + +* `ORG_CONNECTED_TO_VERCEL` (value: `"ORG_CONNECTED_TO_VERCEL"`) + +* `ORG_DISCONNECTED_FROM_VERCEL` (value: `"ORG_DISCONNECTED_FROM_VERCEL"`) + +* `ORG_DISCONNECTED_TO_VERCEL` (value: `"ORG_DISCONNECTED_TO_VERCEL"`) + +* `ORG_CONNECTION_UNINSTALLED_FROM_VERCEL` (value: `"ORG_CONNECTION_UNINSTALLED_FROM_VERCEL"`) + +* `ORG_UI_IP_ACCESS_LIST_ENABLED` (value: `"ORG_UI_IP_ACCESS_LIST_ENABLED"`) + +* `ORG_UI_IP_ACCESS_LIST_DISABLED` (value: `"ORG_UI_IP_ACCESS_LIST_DISABLED"`) + +* `ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES` (value: `"ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrgEventViewForOrg.md b/docs/docs/OrgEventViewForOrg.md new file mode 100644 index 00000000..3bd42833 --- /dev/null +++ b/docs/docs/OrgEventViewForOrg.md @@ -0,0 +1,379 @@ +# OrgEventViewForOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**OrgEventTypeViewForOrg**](OrgEventTypeViewForOrg.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**InvoiceId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies of the invoice associated with the event. | [optional] [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewOrgEventViewForOrg + +`func NewOrgEventViewForOrg(created time.Time, eventTypeName OrgEventTypeViewForOrg, id string, ) *OrgEventViewForOrg` + +NewOrgEventViewForOrg instantiates a new OrgEventViewForOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrgEventViewForOrgWithDefaults + +`func NewOrgEventViewForOrgWithDefaults() *OrgEventViewForOrg` + +NewOrgEventViewForOrgWithDefaults instantiates a new OrgEventViewForOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *OrgEventViewForOrg) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *OrgEventViewForOrg) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *OrgEventViewForOrg) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *OrgEventViewForOrg) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *OrgEventViewForOrg) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *OrgEventViewForOrg) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *OrgEventViewForOrg) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *OrgEventViewForOrg) GetEventTypeName() OrgEventTypeViewForOrg` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *OrgEventViewForOrg) GetEventTypeNameOk() (*OrgEventTypeViewForOrg, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *OrgEventViewForOrg) SetEventTypeName(v OrgEventTypeViewForOrg)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *OrgEventViewForOrg) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *OrgEventViewForOrg) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *OrgEventViewForOrg) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *OrgEventViewForOrg) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *OrgEventViewForOrg) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OrgEventViewForOrg) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OrgEventViewForOrg) SetId(v string)` + +SetId sets Id field to given value. + + +### GetInvoiceId + +`func (o *OrgEventViewForOrg) GetInvoiceId() string` + +GetInvoiceId returns the InvoiceId field if non-nil, zero value otherwise. + +### GetInvoiceIdOk + +`func (o *OrgEventViewForOrg) GetInvoiceIdOk() (*string, bool)` + +GetInvoiceIdOk returns a tuple with the InvoiceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInvoiceId + +`func (o *OrgEventViewForOrg) SetInvoiceId(v string)` + +SetInvoiceId sets InvoiceId field to given value. + +### HasInvoiceId + +`func (o *OrgEventViewForOrg) HasInvoiceId() bool` + +HasInvoiceId returns a boolean if a field has been set. + +### GetIsGlobalAdmin + +`func (o *OrgEventViewForOrg) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *OrgEventViewForOrg) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *OrgEventViewForOrg) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *OrgEventViewForOrg) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *OrgEventViewForOrg) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *OrgEventViewForOrg) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *OrgEventViewForOrg) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *OrgEventViewForOrg) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *OrgEventViewForOrg) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *OrgEventViewForOrg) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *OrgEventViewForOrg) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *OrgEventViewForOrg) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *OrgEventViewForOrg) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *OrgEventViewForOrg) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *OrgEventViewForOrg) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *OrgEventViewForOrg) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *OrgEventViewForOrg) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *OrgEventViewForOrg) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *OrgEventViewForOrg) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *OrgEventViewForOrg) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *OrgEventViewForOrg) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *OrgEventViewForOrg) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *OrgEventViewForOrg) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *OrgEventViewForOrg) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetUserId + +`func (o *OrgEventViewForOrg) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *OrgEventViewForOrg) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *OrgEventViewForOrg) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *OrgEventViewForOrg) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *OrgEventViewForOrg) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *OrgEventViewForOrg) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *OrgEventViewForOrg) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *OrgEventViewForOrg) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrgFederationSettings.md b/docs/docs/OrgFederationSettings.md new file mode 100644 index 00000000..d89dfcb3 --- /dev/null +++ b/docs/docs/OrgFederationSettings.md @@ -0,0 +1,160 @@ +# OrgFederationSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FederatedDomains** | Pointer to **[]string** | List of domains associated with the organization's identity provider. | [optional] +**HasRoleMappings** | Pointer to **bool** | Flag that indicates whether this organization has role mappings configured. | [optional] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this federation. | [optional] [readonly] +**IdentityProviderId** | Pointer to **string** | Unique 20-hexadecimal digit string that identifies the identity provider connected to this organization. | [optional] +**IdentityProviderStatus** | Pointer to **string** | String enum that indicates whether the identity provider is active. | [optional] + +## Methods + +### NewOrgFederationSettings + +`func NewOrgFederationSettings() *OrgFederationSettings` + +NewOrgFederationSettings instantiates a new OrgFederationSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrgFederationSettingsWithDefaults + +`func NewOrgFederationSettingsWithDefaults() *OrgFederationSettings` + +NewOrgFederationSettingsWithDefaults instantiates a new OrgFederationSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFederatedDomains + +`func (o *OrgFederationSettings) GetFederatedDomains() []string` + +GetFederatedDomains returns the FederatedDomains field if non-nil, zero value otherwise. + +### GetFederatedDomainsOk + +`func (o *OrgFederationSettings) GetFederatedDomainsOk() (*[]string, bool)` + +GetFederatedDomainsOk returns a tuple with the FederatedDomains field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederatedDomains + +`func (o *OrgFederationSettings) SetFederatedDomains(v []string)` + +SetFederatedDomains sets FederatedDomains field to given value. + +### HasFederatedDomains + +`func (o *OrgFederationSettings) HasFederatedDomains() bool` + +HasFederatedDomains returns a boolean if a field has been set. + +### GetHasRoleMappings + +`func (o *OrgFederationSettings) GetHasRoleMappings() bool` + +GetHasRoleMappings returns the HasRoleMappings field if non-nil, zero value otherwise. + +### GetHasRoleMappingsOk + +`func (o *OrgFederationSettings) GetHasRoleMappingsOk() (*bool, bool)` + +GetHasRoleMappingsOk returns a tuple with the HasRoleMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasRoleMappings + +`func (o *OrgFederationSettings) SetHasRoleMappings(v bool)` + +SetHasRoleMappings sets HasRoleMappings field to given value. + +### HasHasRoleMappings + +`func (o *OrgFederationSettings) HasHasRoleMappings() bool` + +HasHasRoleMappings returns a boolean if a field has been set. + +### GetId + +`func (o *OrgFederationSettings) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OrgFederationSettings) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OrgFederationSettings) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OrgFederationSettings) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetIdentityProviderId + +`func (o *OrgFederationSettings) GetIdentityProviderId() string` + +GetIdentityProviderId returns the IdentityProviderId field if non-nil, zero value otherwise. + +### GetIdentityProviderIdOk + +`func (o *OrgFederationSettings) GetIdentityProviderIdOk() (*string, bool)` + +GetIdentityProviderIdOk returns a tuple with the IdentityProviderId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProviderId + +`func (o *OrgFederationSettings) SetIdentityProviderId(v string)` + +SetIdentityProviderId sets IdentityProviderId field to given value. + +### HasIdentityProviderId + +`func (o *OrgFederationSettings) HasIdentityProviderId() bool` + +HasIdentityProviderId returns a boolean if a field has been set. + +### GetIdentityProviderStatus + +`func (o *OrgFederationSettings) GetIdentityProviderStatus() string` + +GetIdentityProviderStatus returns the IdentityProviderStatus field if non-nil, zero value otherwise. + +### GetIdentityProviderStatusOk + +`func (o *OrgFederationSettings) GetIdentityProviderStatusOk() (*string, bool)` + +GetIdentityProviderStatusOk returns a tuple with the IdentityProviderStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProviderStatus + +`func (o *OrgFederationSettings) SetIdentityProviderStatus(v string)` + +SetIdentityProviderStatus sets IdentityProviderStatus field to given value. + +### HasIdentityProviderStatus + +`func (o *OrgFederationSettings) HasIdentityProviderStatus() bool` + +HasIdentityProviderStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrgGroup.md b/docs/docs/OrgGroup.md new file mode 100644 index 00000000..dd640c1f --- /dev/null +++ b/docs/docs/OrgGroup.md @@ -0,0 +1,212 @@ +# OrgGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Clusters** | Pointer to [**[]Cluster**](Cluster.md) | Settings that describe the clusters in each project that the API key is authorized to view. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**GroupName** | Pointer to **string** | Human-readable label that identifies the project. | [optional] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that contains the project. | [optional] [readonly] +**OrgName** | Pointer to **string** | Human-readable label that identifies the organization that contains the project. | [optional] +**PlanType** | Pointer to **string** | Human-readable label that indicates the plan type. | [optional] [readonly] +**Tags** | Pointer to **[]string** | List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array. | [optional] [readonly] + +## Methods + +### NewOrgGroup + +`func NewOrgGroup() *OrgGroup` + +NewOrgGroup instantiates a new OrgGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrgGroupWithDefaults + +`func NewOrgGroupWithDefaults() *OrgGroup` + +NewOrgGroupWithDefaults instantiates a new OrgGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusters + +`func (o *OrgGroup) GetClusters() []Cluster` + +GetClusters returns the Clusters field if non-nil, zero value otherwise. + +### GetClustersOk + +`func (o *OrgGroup) GetClustersOk() (*[]Cluster, bool)` + +GetClustersOk returns a tuple with the Clusters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusters + +`func (o *OrgGroup) SetClusters(v []Cluster)` + +SetClusters sets Clusters field to given value. + +### HasClusters + +`func (o *OrgGroup) HasClusters() bool` + +HasClusters returns a boolean if a field has been set. + +### GetGroupId + +`func (o *OrgGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *OrgGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *OrgGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *OrgGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetGroupName + +`func (o *OrgGroup) GetGroupName() string` + +GetGroupName returns the GroupName field if non-nil, zero value otherwise. + +### GetGroupNameOk + +`func (o *OrgGroup) GetGroupNameOk() (*string, bool)` + +GetGroupNameOk returns a tuple with the GroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupName + +`func (o *OrgGroup) SetGroupName(v string)` + +SetGroupName sets GroupName field to given value. + +### HasGroupName + +`func (o *OrgGroup) HasGroupName() bool` + +HasGroupName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *OrgGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *OrgGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *OrgGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *OrgGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetOrgName + +`func (o *OrgGroup) GetOrgName() string` + +GetOrgName returns the OrgName field if non-nil, zero value otherwise. + +### GetOrgNameOk + +`func (o *OrgGroup) GetOrgNameOk() (*string, bool)` + +GetOrgNameOk returns a tuple with the OrgName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgName + +`func (o *OrgGroup) SetOrgName(v string)` + +SetOrgName sets OrgName field to given value. + +### HasOrgName + +`func (o *OrgGroup) HasOrgName() bool` + +HasOrgName returns a boolean if a field has been set. + +### GetPlanType + +`func (o *OrgGroup) GetPlanType() string` + +GetPlanType returns the PlanType field if non-nil, zero value otherwise. + +### GetPlanTypeOk + +`func (o *OrgGroup) GetPlanTypeOk() (*string, bool)` + +GetPlanTypeOk returns a tuple with the PlanType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlanType + +`func (o *OrgGroup) SetPlanType(v string)` + +SetPlanType sets PlanType field to given value. + +### HasPlanType + +`func (o *OrgGroup) HasPlanType() bool` + +HasPlanType returns a boolean if a field has been set. + +### GetTags + +`func (o *OrgGroup) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *OrgGroup) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *OrgGroup) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *OrgGroup) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrgNotification.md b/docs/docs/OrgNotification.md new file mode 100644 index 00000000..d85157c9 --- /dev/null +++ b/docs/docs/OrgNotification.md @@ -0,0 +1,181 @@ +# OrgNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**EmailEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**Roles** | Pointer to **[]string** | List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role. | [optional] +**SmsEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewOrgNotification + +`func NewOrgNotification(typeName string, ) *OrgNotification` + +NewOrgNotification instantiates a new OrgNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrgNotificationWithDefaults + +`func NewOrgNotificationWithDefaults() *OrgNotification` + +NewOrgNotificationWithDefaults instantiates a new OrgNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *OrgNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *OrgNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *OrgNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *OrgNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetEmailEnabled + +`func (o *OrgNotification) GetEmailEnabled() bool` + +GetEmailEnabled returns the EmailEnabled field if non-nil, zero value otherwise. + +### GetEmailEnabledOk + +`func (o *OrgNotification) GetEmailEnabledOk() (*bool, bool)` + +GetEmailEnabledOk returns a tuple with the EmailEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEnabled + +`func (o *OrgNotification) SetEmailEnabled(v bool)` + +SetEmailEnabled sets EmailEnabled field to given value. + +### HasEmailEnabled + +`func (o *OrgNotification) HasEmailEnabled() bool` + +HasEmailEnabled returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *OrgNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *OrgNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *OrgNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *OrgNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetRoles + +`func (o *OrgNotification) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *OrgNotification) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *OrgNotification) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *OrgNotification) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetSmsEnabled + +`func (o *OrgNotification) GetSmsEnabled() bool` + +GetSmsEnabled returns the SmsEnabled field if non-nil, zero value otherwise. + +### GetSmsEnabledOk + +`func (o *OrgNotification) GetSmsEnabledOk() (*bool, bool)` + +GetSmsEnabledOk returns a tuple with the SmsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSmsEnabled + +`func (o *OrgNotification) SetSmsEnabled(v bool)` + +SetSmsEnabled sets SmsEnabled field to given value. + +### HasSmsEnabled + +`func (o *OrgNotification) HasSmsEnabled() bool` + +HasSmsEnabled returns a boolean if a field has been set. + +### GetTypeName + +`func (o *OrgNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *OrgNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *OrgNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrgPaginatedEvent.md b/docs/docs/OrgPaginatedEvent.md new file mode 100644 index 00000000..cac411c9 --- /dev/null +++ b/docs/docs/OrgPaginatedEvent.md @@ -0,0 +1,108 @@ +# OrgPaginatedEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]EventViewForOrg**](EventViewForOrg.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response if **includeCount** query param is true. | [optional] [readonly] + +## Methods + +### NewOrgPaginatedEvent + +`func NewOrgPaginatedEvent() *OrgPaginatedEvent` + +NewOrgPaginatedEvent instantiates a new OrgPaginatedEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrgPaginatedEventWithDefaults + +`func NewOrgPaginatedEventWithDefaults() *OrgPaginatedEvent` + +NewOrgPaginatedEventWithDefaults instantiates a new OrgPaginatedEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *OrgPaginatedEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *OrgPaginatedEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *OrgPaginatedEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *OrgPaginatedEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *OrgPaginatedEvent) GetResults() []EventViewForOrg` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *OrgPaginatedEvent) GetResultsOk() (*[]EventViewForOrg, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *OrgPaginatedEvent) SetResults(v []EventViewForOrg)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *OrgPaginatedEvent) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *OrgPaginatedEvent) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *OrgPaginatedEvent) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *OrgPaginatedEvent) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *OrgPaginatedEvent) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Organization.md b/docs/docs/Organization.md new file mode 100644 index 00000000..01c1cc21 --- /dev/null +++ b/docs/docs/Organization.md @@ -0,0 +1,129 @@ +# Organization + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization. | [optional] [readonly] +**IsDeleted** | Pointer to **bool** | Flag that indicates whether this organization has been deleted. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Name** | **string** | Human-readable label that identifies the organization. | + +## Methods + +### NewOrganization + +`func NewOrganization(name string, ) *Organization` + +NewOrganization instantiates a new Organization object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrganizationWithDefaults + +`func NewOrganizationWithDefaults() *Organization` + +NewOrganizationWithDefaults instantiates a new Organization object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *Organization) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Organization) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Organization) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Organization) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetIsDeleted + +`func (o *Organization) GetIsDeleted() bool` + +GetIsDeleted returns the IsDeleted field if non-nil, zero value otherwise. + +### GetIsDeletedOk + +`func (o *Organization) GetIsDeletedOk() (*bool, bool)` + +GetIsDeletedOk returns a tuple with the IsDeleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDeleted + +`func (o *Organization) SetIsDeleted(v bool)` + +SetIsDeleted sets IsDeleted field to given value. + +### HasIsDeleted + +`func (o *Organization) HasIsDeleted() bool` + +HasIsDeleted returns a boolean if a field has been set. + +### GetLinks + +`func (o *Organization) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Organization) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Organization) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Organization) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetName + +`func (o *Organization) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Organization) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Organization) SetName(v string)` + +SetName sets Name field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrganizationInvitation.md b/docs/docs/OrganizationInvitation.md new file mode 100644 index 00000000..0a35a408 --- /dev/null +++ b/docs/docs/OrganizationInvitation.md @@ -0,0 +1,285 @@ +# OrganizationInvitation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this organization. | [optional] [readonly] +**InviterUsername** | Pointer to **string** | Email address of the MongoDB Cloud user who sent the invitation to join the organization. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization. | [optional] [readonly] +**OrgName** | **string** | Human-readable label that identifies this organization. | +**Roles** | Pointer to **[]string** | One or more organization or project level roles to assign to the MongoDB Cloud user. | [optional] +**TeamIds** | Pointer to **[]string** | List of unique 24-hexadecimal digit strings that identifies each team. | [optional] [readonly] +**Username** | Pointer to **string** | Email address of the MongoDB Cloud user invited to join the organization. | [optional] + +## Methods + +### NewOrganizationInvitation + +`func NewOrganizationInvitation(orgName string, ) *OrganizationInvitation` + +NewOrganizationInvitation instantiates a new OrganizationInvitation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrganizationInvitationWithDefaults + +`func NewOrganizationInvitationWithDefaults() *OrganizationInvitation` + +NewOrganizationInvitationWithDefaults instantiates a new OrganizationInvitation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreatedAt + +`func (o *OrganizationInvitation) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *OrganizationInvitation) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *OrganizationInvitation) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *OrganizationInvitation) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *OrganizationInvitation) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *OrganizationInvitation) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *OrganizationInvitation) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *OrganizationInvitation) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetId + +`func (o *OrganizationInvitation) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OrganizationInvitation) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OrganizationInvitation) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OrganizationInvitation) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetInviterUsername + +`func (o *OrganizationInvitation) GetInviterUsername() string` + +GetInviterUsername returns the InviterUsername field if non-nil, zero value otherwise. + +### GetInviterUsernameOk + +`func (o *OrganizationInvitation) GetInviterUsernameOk() (*string, bool)` + +GetInviterUsernameOk returns a tuple with the InviterUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInviterUsername + +`func (o *OrganizationInvitation) SetInviterUsername(v string)` + +SetInviterUsername sets InviterUsername field to given value. + +### HasInviterUsername + +`func (o *OrganizationInvitation) HasInviterUsername() bool` + +HasInviterUsername returns a boolean if a field has been set. + +### GetLinks + +`func (o *OrganizationInvitation) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *OrganizationInvitation) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *OrganizationInvitation) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *OrganizationInvitation) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *OrganizationInvitation) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *OrganizationInvitation) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *OrganizationInvitation) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *OrganizationInvitation) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetOrgName + +`func (o *OrganizationInvitation) GetOrgName() string` + +GetOrgName returns the OrgName field if non-nil, zero value otherwise. + +### GetOrgNameOk + +`func (o *OrganizationInvitation) GetOrgNameOk() (*string, bool)` + +GetOrgNameOk returns a tuple with the OrgName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgName + +`func (o *OrganizationInvitation) SetOrgName(v string)` + +SetOrgName sets OrgName field to given value. + + +### GetRoles + +`func (o *OrganizationInvitation) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *OrganizationInvitation) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *OrganizationInvitation) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *OrganizationInvitation) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetTeamIds + +`func (o *OrganizationInvitation) GetTeamIds() []string` + +GetTeamIds returns the TeamIds field if non-nil, zero value otherwise. + +### GetTeamIdsOk + +`func (o *OrganizationInvitation) GetTeamIdsOk() (*[]string, bool)` + +GetTeamIdsOk returns a tuple with the TeamIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamIds + +`func (o *OrganizationInvitation) SetTeamIds(v []string)` + +SetTeamIds sets TeamIds field to given value. + +### HasTeamIds + +`func (o *OrganizationInvitation) HasTeamIds() bool` + +HasTeamIds returns a boolean if a field has been set. + +### GetUsername + +`func (o *OrganizationInvitation) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *OrganizationInvitation) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *OrganizationInvitation) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *OrganizationInvitation) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrganizationInvitationRequest.md b/docs/docs/OrganizationInvitationRequest.md new file mode 100644 index 00000000..840d7f79 --- /dev/null +++ b/docs/docs/OrganizationInvitationRequest.md @@ -0,0 +1,108 @@ +# OrganizationInvitationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Roles** | Pointer to **[]string** | One or more organization or project level roles to assign to the MongoDB Cloud user. | [optional] +**TeamIds** | Pointer to **[]string** | List of teams to which you want to invite the desired MongoDB Cloud user. | [optional] +**Username** | Pointer to **string** | Email address that belongs to the desired MongoDB Cloud user. | [optional] + +## Methods + +### NewOrganizationInvitationRequest + +`func NewOrganizationInvitationRequest() *OrganizationInvitationRequest` + +NewOrganizationInvitationRequest instantiates a new OrganizationInvitationRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrganizationInvitationRequestWithDefaults + +`func NewOrganizationInvitationRequestWithDefaults() *OrganizationInvitationRequest` + +NewOrganizationInvitationRequestWithDefaults instantiates a new OrganizationInvitationRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRoles + +`func (o *OrganizationInvitationRequest) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *OrganizationInvitationRequest) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *OrganizationInvitationRequest) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *OrganizationInvitationRequest) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetTeamIds + +`func (o *OrganizationInvitationRequest) GetTeamIds() []string` + +GetTeamIds returns the TeamIds field if non-nil, zero value otherwise. + +### GetTeamIdsOk + +`func (o *OrganizationInvitationRequest) GetTeamIdsOk() (*[]string, bool)` + +GetTeamIdsOk returns a tuple with the TeamIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamIds + +`func (o *OrganizationInvitationRequest) SetTeamIds(v []string)` + +SetTeamIds sets TeamIds field to given value. + +### HasTeamIds + +`func (o *OrganizationInvitationRequest) HasTeamIds() bool` + +HasTeamIds returns a boolean if a field has been set. + +### GetUsername + +`func (o *OrganizationInvitationRequest) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *OrganizationInvitationRequest) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *OrganizationInvitationRequest) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *OrganizationInvitationRequest) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrganizationInvitationUpdateRequest.md b/docs/docs/OrganizationInvitationUpdateRequest.md new file mode 100644 index 00000000..1fa6347a --- /dev/null +++ b/docs/docs/OrganizationInvitationUpdateRequest.md @@ -0,0 +1,82 @@ +# OrganizationInvitationUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Roles** | Pointer to **[]string** | One or more organization or project level roles to assign to the MongoDB Cloud user. | [optional] +**TeamIds** | Pointer to **[]string** | List of teams to which you want to invite the desired MongoDB Cloud user. | [optional] + +## Methods + +### NewOrganizationInvitationUpdateRequest + +`func NewOrganizationInvitationUpdateRequest() *OrganizationInvitationUpdateRequest` + +NewOrganizationInvitationUpdateRequest instantiates a new OrganizationInvitationUpdateRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrganizationInvitationUpdateRequestWithDefaults + +`func NewOrganizationInvitationUpdateRequestWithDefaults() *OrganizationInvitationUpdateRequest` + +NewOrganizationInvitationUpdateRequestWithDefaults instantiates a new OrganizationInvitationUpdateRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRoles + +`func (o *OrganizationInvitationUpdateRequest) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *OrganizationInvitationUpdateRequest) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *OrganizationInvitationUpdateRequest) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *OrganizationInvitationUpdateRequest) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetTeamIds + +`func (o *OrganizationInvitationUpdateRequest) GetTeamIds() []string` + +GetTeamIds returns the TeamIds field if non-nil, zero value otherwise. + +### GetTeamIdsOk + +`func (o *OrganizationInvitationUpdateRequest) GetTeamIdsOk() (*[]string, bool)` + +GetTeamIdsOk returns a tuple with the TeamIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamIds + +`func (o *OrganizationInvitationUpdateRequest) SetTeamIds(v []string)` + +SetTeamIds sets TeamIds field to given value. + +### HasTeamIds + +`func (o *OrganizationInvitationUpdateRequest) HasTeamIds() bool` + +HasTeamIds returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrganizationSettings.md b/docs/docs/OrganizationSettings.md new file mode 100644 index 00000000..46200fff --- /dev/null +++ b/docs/docs/OrganizationSettings.md @@ -0,0 +1,108 @@ +# OrganizationSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiAccessListRequired** | Pointer to **bool** | Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization. | [optional] +**MultiFactorAuthRequired** | Pointer to **bool** | Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/. | [optional] +**RestrictEmployeeAccess** | Pointer to **bool** | Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/. | [optional] + +## Methods + +### NewOrganizationSettings + +`func NewOrganizationSettings() *OrganizationSettings` + +NewOrganizationSettings instantiates a new OrganizationSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOrganizationSettingsWithDefaults + +`func NewOrganizationSettingsWithDefaults() *OrganizationSettings` + +NewOrganizationSettingsWithDefaults instantiates a new OrganizationSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiAccessListRequired + +`func (o *OrganizationSettings) GetApiAccessListRequired() bool` + +GetApiAccessListRequired returns the ApiAccessListRequired field if non-nil, zero value otherwise. + +### GetApiAccessListRequiredOk + +`func (o *OrganizationSettings) GetApiAccessListRequiredOk() (*bool, bool)` + +GetApiAccessListRequiredOk returns a tuple with the ApiAccessListRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiAccessListRequired + +`func (o *OrganizationSettings) SetApiAccessListRequired(v bool)` + +SetApiAccessListRequired sets ApiAccessListRequired field to given value. + +### HasApiAccessListRequired + +`func (o *OrganizationSettings) HasApiAccessListRequired() bool` + +HasApiAccessListRequired returns a boolean if a field has been set. + +### GetMultiFactorAuthRequired + +`func (o *OrganizationSettings) GetMultiFactorAuthRequired() bool` + +GetMultiFactorAuthRequired returns the MultiFactorAuthRequired field if non-nil, zero value otherwise. + +### GetMultiFactorAuthRequiredOk + +`func (o *OrganizationSettings) GetMultiFactorAuthRequiredOk() (*bool, bool)` + +GetMultiFactorAuthRequiredOk returns a tuple with the MultiFactorAuthRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiFactorAuthRequired + +`func (o *OrganizationSettings) SetMultiFactorAuthRequired(v bool)` + +SetMultiFactorAuthRequired sets MultiFactorAuthRequired field to given value. + +### HasMultiFactorAuthRequired + +`func (o *OrganizationSettings) HasMultiFactorAuthRequired() bool` + +HasMultiFactorAuthRequired returns a boolean if a field has been set. + +### GetRestrictEmployeeAccess + +`func (o *OrganizationSettings) GetRestrictEmployeeAccess() bool` + +GetRestrictEmployeeAccess returns the RestrictEmployeeAccess field if non-nil, zero value otherwise. + +### GetRestrictEmployeeAccessOk + +`func (o *OrganizationSettings) GetRestrictEmployeeAccessOk() (*bool, bool)` + +GetRestrictEmployeeAccessOk returns a tuple with the RestrictEmployeeAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestrictEmployeeAccess + +`func (o *OrganizationSettings) SetRestrictEmployeeAccess(v bool)` + +SetRestrictEmployeeAccess sets RestrictEmployeeAccess field to given value. + +### HasRestrictEmployeeAccess + +`func (o *OrganizationSettings) HasRestrictEmployeeAccess() bool` + +HasRestrictEmployeeAccess returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/OrganizationsApi.md b/docs/docs/OrganizationsApi.md new file mode 100644 index 00000000..894b057a --- /dev/null +++ b/docs/docs/OrganizationsApi.md @@ -0,0 +1,1162 @@ +# \OrganizationsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateOrganization**](OrganizationsApi.md#CreateOrganization) | **Post** /api/atlas/v2/orgs | Create One Organization +[**CreateOrganizationInvitation**](OrganizationsApi.md#CreateOrganizationInvitation) | **Post** /api/atlas/v2/orgs/{orgId}/invites | Invite One MongoDB Cloud User to Join One Atlas Organization +[**DeleteOrganization**](OrganizationsApi.md#DeleteOrganization) | **Delete** /api/atlas/v2/orgs/{orgId} | Remove One Organization +[**DeleteOrganizationInvitation**](OrganizationsApi.md#DeleteOrganizationInvitation) | **Delete** /api/atlas/v2/orgs/{orgId}/invites/{invitationId} | Cancel One Organization Invitation +[**GetOrganization**](OrganizationsApi.md#GetOrganization) | **Get** /api/atlas/v2/orgs/{orgId} | Return One Organization +[**GetOrganizationInvitation**](OrganizationsApi.md#GetOrganizationInvitation) | **Get** /api/atlas/v2/orgs/{orgId}/invites/{invitationId} | Return One Organization Invitation +[**GetOrganizationSettings**](OrganizationsApi.md#GetOrganizationSettings) | **Get** /api/atlas/v2/orgs/{orgId}/settings | Return Settings for One Organization +[**ListOrganizationInvitations**](OrganizationsApi.md#ListOrganizationInvitations) | **Get** /api/atlas/v2/orgs/{orgId}/invites | Return All Organization Invitations +[**ListOrganizationProjects**](OrganizationsApi.md#ListOrganizationProjects) | **Get** /api/atlas/v2/orgs/{orgId}/groups | Return One or More Projects in One Organization +[**ListOrganizationUsers**](OrganizationsApi.md#ListOrganizationUsers) | **Get** /api/atlas/v2/orgs/{orgId}/users | Return All MongoDB Cloud Users in One Organization +[**ListOrganizations**](OrganizationsApi.md#ListOrganizations) | **Get** /api/atlas/v2/orgs | Return All Organizations +[**RenameOrganization**](OrganizationsApi.md#RenameOrganization) | **Patch** /api/atlas/v2/orgs/{orgId} | Rename One Organization +[**UpdateOrganizationInvitation**](OrganizationsApi.md#UpdateOrganizationInvitation) | **Patch** /api/atlas/v2/orgs/{orgId}/invites | Update One Organization Invitation +[**UpdateOrganizationInvitationById**](OrganizationsApi.md#UpdateOrganizationInvitationById) | **Patch** /api/atlas/v2/orgs/{orgId}/invites/{invitationId} | Update One Organization Invitation by Invitation ID +[**UpdateOrganizationSettings**](OrganizationsApi.md#UpdateOrganizationSettings) | **Patch** /api/atlas/v2/orgs/{orgId}/settings | Update Settings for One Organization + + + +## CreateOrganization + +> CreateOrganizationResponse CreateOrganization(ctx).CreateOrganizationRequest(createOrganizationRequest).Execute() + +Create One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + createOrganizationRequest := *openapiclient.NewCreateOrganizationRequest("Name_example") // CreateOrganizationRequest | + + resp, r, err := sdk.OrganizationsApi.CreateOrganization(context.Background()).CreateOrganizationRequest(createOrganizationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.CreateOrganization``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateOrganization`: CreateOrganizationResponse + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.CreateOrganization`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOrganizationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createOrganizationRequest** | [**CreateOrganizationRequest**](CreateOrganizationRequest.md) | Organization that you want to create. | + +### Return type + +[**CreateOrganizationResponse**](CreateOrganizationResponse.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateOrganizationInvitation + +> OrganizationInvitation CreateOrganizationInvitation(ctx, orgId).OrganizationInvitationRequest(organizationInvitationRequest).Execute() + +Invite One MongoDB Cloud User to Join One Atlas Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + organizationInvitationRequest := *openapiclient.NewOrganizationInvitationRequest() // OrganizationInvitationRequest | + + resp, r, err := sdk.OrganizationsApi.CreateOrganizationInvitation(context.Background(), orgId).OrganizationInvitationRequest(organizationInvitationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.CreateOrganizationInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateOrganizationInvitation`: OrganizationInvitation + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.CreateOrganizationInvitation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOrganizationInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **organizationInvitationRequest** | [**OrganizationInvitationRequest**](OrganizationInvitationRequest.md) | Invites one MongoDB Cloud user to join the specified organization. | + +### Return type + +[**OrganizationInvitation**](OrganizationInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteOrganization + +> DeleteOrganization(ctx, orgId).Execute() + +Remove One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + + r, err := sdk.OrganizationsApi.DeleteOrganization(context.Background(), orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.DeleteOrganization``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOrganizationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteOrganizationInvitation + +> DeleteOrganizationInvitation(ctx, orgId, invitationId).Execute() + +Cancel One Organization Invitation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + invitationId := "invitationId_example" // string | + + r, err := sdk.OrganizationsApi.DeleteOrganizationInvitation(context.Background(), orgId, invitationId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.DeleteOrganizationInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**invitationId** | **string** | Unique 24-hexadecimal digit string that identifies the invitation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOrganizationInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOrganization + +> Organization GetOrganization(ctx, orgId).Execute() + +Return One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + + resp, r, err := sdk.OrganizationsApi.GetOrganization(context.Background(), orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.GetOrganization``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetOrganization`: Organization + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.GetOrganization`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOrganizationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Organization**](Organization.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOrganizationInvitation + +> OrganizationInvitation GetOrganizationInvitation(ctx, orgId, invitationId).Execute() + +Return One Organization Invitation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + invitationId := "invitationId_example" // string | + + resp, r, err := sdk.OrganizationsApi.GetOrganizationInvitation(context.Background(), orgId, invitationId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.GetOrganizationInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetOrganizationInvitation`: OrganizationInvitation + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.GetOrganizationInvitation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**invitationId** | **string** | Unique 24-hexadecimal digit string that identifies the invitation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOrganizationInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**OrganizationInvitation**](OrganizationInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOrganizationSettings + +> OrganizationSettings GetOrganizationSettings(ctx, orgId).Execute() + +Return Settings for One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + + resp, r, err := sdk.OrganizationsApi.GetOrganizationSettings(context.Background(), orgId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.GetOrganizationSettings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetOrganizationSettings`: OrganizationSettings + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.GetOrganizationSettings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOrganizationSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**OrganizationSettings**](OrganizationSettings.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListOrganizationInvitations + +> []OrganizationInvitation ListOrganizationInvitations(ctx, orgId).Username(username).Execute() + +Return All Organization Invitations + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + username := "username_example" // string | (optional) + + resp, r, err := sdk.OrganizationsApi.ListOrganizationInvitations(context.Background(), orgId).Username(username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.ListOrganizationInvitations``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListOrganizationInvitations`: []OrganizationInvitation + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.ListOrganizationInvitations`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOrganizationInvitationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **username** | **string** | Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations. | + +### Return type + +[**[]OrganizationInvitation**](OrganizationInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListOrganizationProjects + +> PaginatedAtlasGroup ListOrganizationProjects(ctx, orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Name(name).Execute() + +Return One or More Projects in One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + name := "name_example" // string | (optional) + + resp, r, err := sdk.OrganizationsApi.ListOrganizationProjects(context.Background(), orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.ListOrganizationProjects``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListOrganizationProjects`: PaginatedAtlasGroup + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.ListOrganizationProjects`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOrganizationProjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **name** | **string** | Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name. | + +### Return type + +[**PaginatedAtlasGroup**](PaginatedAtlasGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListOrganizationUsers + +> PaginatedAppUser ListOrganizationUsers(ctx, orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All MongoDB Cloud Users in One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.OrganizationsApi.ListOrganizationUsers(context.Background(), orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.ListOrganizationUsers``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListOrganizationUsers`: PaginatedAppUser + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.ListOrganizationUsers`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOrganizationUsersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedAppUser**](PaginatedAppUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListOrganizations + +> PaginatedOrganization ListOrganizations(ctx).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Name(name).Execute() + +Return All Organizations + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + name := "name_example" // string | (optional) + + resp, r, err := sdk.OrganizationsApi.ListOrganizations(context.Background()).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.ListOrganizations``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListOrganizations`: PaginatedOrganization + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.ListOrganizations`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOrganizationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **name** | **string** | Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name. | + +### Return type + +[**PaginatedOrganization**](PaginatedOrganization.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RenameOrganization + +> Organization RenameOrganization(ctx, orgId).Organization(organization).Execute() + +Rename One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + organization := *openapiclient.NewOrganization("Name_example") // Organization | + + resp, r, err := sdk.OrganizationsApi.RenameOrganization(context.Background(), orgId).Organization(organization).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.RenameOrganization``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `RenameOrganization`: Organization + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.RenameOrganization`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRenameOrganizationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **organization** | [**Organization**](Organization.md) | Details to update on the specified organization. | + +### Return type + +[**Organization**](Organization.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateOrganizationInvitation + +> OrganizationInvitation UpdateOrganizationInvitation(ctx, orgId).OrganizationInvitationRequest(organizationInvitationRequest).Execute() + +Update One Organization Invitation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + organizationInvitationRequest := *openapiclient.NewOrganizationInvitationRequest() // OrganizationInvitationRequest | + + resp, r, err := sdk.OrganizationsApi.UpdateOrganizationInvitation(context.Background(), orgId).OrganizationInvitationRequest(organizationInvitationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.UpdateOrganizationInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateOrganizationInvitation`: OrganizationInvitation + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.UpdateOrganizationInvitation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateOrganizationInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **organizationInvitationRequest** | [**OrganizationInvitationRequest**](OrganizationInvitationRequest.md) | Updates the details of one pending invitation to the specified organization. | + +### Return type + +[**OrganizationInvitation**](OrganizationInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateOrganizationInvitationById + +> OrganizationInvitation UpdateOrganizationInvitationById(ctx, orgId, invitationId).OrganizationInvitationUpdateRequest(organizationInvitationUpdateRequest).Execute() + +Update One Organization Invitation by Invitation ID + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + invitationId := "invitationId_example" // string | + organizationInvitationUpdateRequest := *openapiclient.NewOrganizationInvitationUpdateRequest() // OrganizationInvitationUpdateRequest | + + resp, r, err := sdk.OrganizationsApi.UpdateOrganizationInvitationById(context.Background(), orgId, invitationId).OrganizationInvitationUpdateRequest(organizationInvitationUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.UpdateOrganizationInvitationById``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateOrganizationInvitationById`: OrganizationInvitation + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.UpdateOrganizationInvitationById`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**invitationId** | **string** | Unique 24-hexadecimal digit string that identifies the invitation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateOrganizationInvitationByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **organizationInvitationUpdateRequest** | [**OrganizationInvitationUpdateRequest**](OrganizationInvitationUpdateRequest.md) | Updates the details of one pending invitation to the specified organization. | + +### Return type + +[**OrganizationInvitation**](OrganizationInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateOrganizationSettings + +> OrganizationSettings UpdateOrganizationSettings(ctx, orgId).OrganizationSettings(organizationSettings).Execute() + +Update Settings for One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + organizationSettings := *openapiclient.NewOrganizationSettings() // OrganizationSettings | + + resp, r, err := sdk.OrganizationsApi.UpdateOrganizationSettings(context.Background(), orgId).OrganizationSettings(organizationSettings).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.UpdateOrganizationSettings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateOrganizationSettings`: OrganizationSettings + fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.UpdateOrganizationSettings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateOrganizationSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **organizationSettings** | [**OrganizationSettings**](OrganizationSettings.md) | Details to update on the specified organization's settings. | + +### Return type + +[**OrganizationSettings**](OrganizationSettings.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/PagerDuty.md b/docs/docs/PagerDuty.md new file mode 100644 index 00000000..e3829032 --- /dev/null +++ b/docs/docs/PagerDuty.md @@ -0,0 +1,103 @@ +# PagerDuty + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Region** | Pointer to **string** | PagerDuty region that indicates the API Uniform Resource Locator (URL) to use. | [optional] +**ServiceKey** | **string** | Service key associated with your PagerDuty account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] + +## Methods + +### NewPagerDuty + +`func NewPagerDuty(serviceKey string, ) *PagerDuty` + +NewPagerDuty instantiates a new PagerDuty object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPagerDutyWithDefaults + +`func NewPagerDutyWithDefaults() *PagerDuty` + +NewPagerDutyWithDefaults instantiates a new PagerDuty object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRegion + +`func (o *PagerDuty) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *PagerDuty) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *PagerDuty) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *PagerDuty) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetServiceKey + +`func (o *PagerDuty) GetServiceKey() string` + +GetServiceKey returns the ServiceKey field if non-nil, zero value otherwise. + +### GetServiceKeyOk + +`func (o *PagerDuty) GetServiceKeyOk() (*string, bool)` + +GetServiceKeyOk returns a tuple with the ServiceKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceKey + +`func (o *PagerDuty) SetServiceKey(v string)` + +SetServiceKey sets ServiceKey field to given value. + + +### GetType + +`func (o *PagerDuty) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PagerDuty) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PagerDuty) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PagerDuty) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PagerDutyNotification.md b/docs/docs/PagerDutyNotification.md new file mode 100644 index 00000000..14981fdf --- /dev/null +++ b/docs/docs/PagerDutyNotification.md @@ -0,0 +1,155 @@ +# PagerDutyNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**Region** | Pointer to **string** | PagerDuty region that indicates which API Uniform Resource Locator (URL) to use. | [optional] [default to "US"] +**ServiceKey** | Pointer to **string** | PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewPagerDutyNotification + +`func NewPagerDutyNotification(typeName string, ) *PagerDutyNotification` + +NewPagerDutyNotification instantiates a new PagerDutyNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPagerDutyNotificationWithDefaults + +`func NewPagerDutyNotificationWithDefaults() *PagerDutyNotification` + +NewPagerDutyNotificationWithDefaults instantiates a new PagerDutyNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *PagerDutyNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *PagerDutyNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *PagerDutyNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *PagerDutyNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *PagerDutyNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *PagerDutyNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *PagerDutyNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *PagerDutyNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetRegion + +`func (o *PagerDutyNotification) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *PagerDutyNotification) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *PagerDutyNotification) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *PagerDutyNotification) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetServiceKey + +`func (o *PagerDutyNotification) GetServiceKey() string` + +GetServiceKey returns the ServiceKey field if non-nil, zero value otherwise. + +### GetServiceKeyOk + +`func (o *PagerDutyNotification) GetServiceKeyOk() (*string, bool)` + +GetServiceKeyOk returns a tuple with the ServiceKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceKey + +`func (o *PagerDutyNotification) SetServiceKey(v string)` + +SetServiceKey sets ServiceKey field to given value. + +### HasServiceKey + +`func (o *PagerDutyNotification) HasServiceKey() bool` + +HasServiceKey returns a boolean if a field has been set. + +### GetTypeName + +`func (o *PagerDutyNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *PagerDutyNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *PagerDutyNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedAWSPeerVpc.md b/docs/docs/PaginatedAWSPeerVpc.md new file mode 100644 index 00000000..5828af07 --- /dev/null +++ b/docs/docs/PaginatedAWSPeerVpc.md @@ -0,0 +1,108 @@ +# PaginatedAWSPeerVpc + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]AWSPeerVpc**](AWSPeerVpc.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedAWSPeerVpc + +`func NewPaginatedAWSPeerVpc() *PaginatedAWSPeerVpc` + +NewPaginatedAWSPeerVpc instantiates a new PaginatedAWSPeerVpc object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedAWSPeerVpcWithDefaults + +`func NewPaginatedAWSPeerVpcWithDefaults() *PaginatedAWSPeerVpc` + +NewPaginatedAWSPeerVpcWithDefaults instantiates a new PaginatedAWSPeerVpc object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedAWSPeerVpc) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedAWSPeerVpc) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedAWSPeerVpc) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedAWSPeerVpc) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedAWSPeerVpc) GetResults() []AWSPeerVpc` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedAWSPeerVpc) GetResultsOk() (*[]AWSPeerVpc, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedAWSPeerVpc) SetResults(v []AWSPeerVpc)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedAWSPeerVpc) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedAWSPeerVpc) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedAWSPeerVpc) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedAWSPeerVpc) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedAWSPeerVpc) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedAlert.md b/docs/docs/PaginatedAlert.md new file mode 100644 index 00000000..93c73974 --- /dev/null +++ b/docs/docs/PaginatedAlert.md @@ -0,0 +1,108 @@ +# PaginatedAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]AlertViewForNdsGroup**](AlertViewForNdsGroup.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response if **includeCount** query param is true. | [optional] [readonly] + +## Methods + +### NewPaginatedAlert + +`func NewPaginatedAlert() *PaginatedAlert` + +NewPaginatedAlert instantiates a new PaginatedAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedAlertWithDefaults + +`func NewPaginatedAlertWithDefaults() *PaginatedAlert` + +NewPaginatedAlertWithDefaults instantiates a new PaginatedAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedAlert) GetResults() []AlertViewForNdsGroup` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedAlert) GetResultsOk() (*[]AlertViewForNdsGroup, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedAlert) SetResults(v []AlertViewForNdsGroup)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedAlert) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedAlert) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedAlert) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedAlert) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedAlert) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedAlertConfig.md b/docs/docs/PaginatedAlertConfig.md new file mode 100644 index 00000000..9d620884 --- /dev/null +++ b/docs/docs/PaginatedAlertConfig.md @@ -0,0 +1,108 @@ +# PaginatedAlertConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]AlertConfigViewForNdsGroup**](AlertConfigViewForNdsGroup.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response if **includeCount** query param is true. | [optional] [readonly] + +## Methods + +### NewPaginatedAlertConfig + +`func NewPaginatedAlertConfig() *PaginatedAlertConfig` + +NewPaginatedAlertConfig instantiates a new PaginatedAlertConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedAlertConfigWithDefaults + +`func NewPaginatedAlertConfigWithDefaults() *PaginatedAlertConfig` + +NewPaginatedAlertConfigWithDefaults instantiates a new PaginatedAlertConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedAlertConfig) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedAlertConfig) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedAlertConfig) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedAlertConfig) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedAlertConfig) GetResults() []AlertConfigViewForNdsGroup` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedAlertConfig) GetResultsOk() (*[]AlertConfigViewForNdsGroup, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedAlertConfig) SetResults(v []AlertConfigViewForNdsGroup)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedAlertConfig) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedAlertConfig) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedAlertConfig) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedAlertConfig) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedAlertConfig) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiApiUser.md b/docs/docs/PaginatedApiApiUser.md new file mode 100644 index 00000000..5ed605bd --- /dev/null +++ b/docs/docs/PaginatedApiApiUser.md @@ -0,0 +1,108 @@ +# PaginatedApiApiUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]ApiUser**](ApiUser.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiApiUser + +`func NewPaginatedApiApiUser() *PaginatedApiApiUser` + +NewPaginatedApiApiUser instantiates a new PaginatedApiApiUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiApiUserWithDefaults + +`func NewPaginatedApiApiUserWithDefaults() *PaginatedApiApiUser` + +NewPaginatedApiApiUserWithDefaults instantiates a new PaginatedApiApiUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiApiUser) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiApiUser) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiApiUser) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiApiUser) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiApiUser) GetResults() []ApiUser` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiApiUser) GetResultsOk() (*[]ApiUser, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiApiUser) SetResults(v []ApiUser)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiApiUser) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiApiUser) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiApiUser) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiApiUser) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiApiUser) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiAppUser.md b/docs/docs/PaginatedApiAppUser.md new file mode 100644 index 00000000..c406656d --- /dev/null +++ b/docs/docs/PaginatedApiAppUser.md @@ -0,0 +1,108 @@ +# PaginatedApiAppUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]AppUser**](AppUser.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiAppUser + +`func NewPaginatedApiAppUser() *PaginatedApiAppUser` + +NewPaginatedApiAppUser instantiates a new PaginatedApiAppUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiAppUserWithDefaults + +`func NewPaginatedApiAppUserWithDefaults() *PaginatedApiAppUser` + +NewPaginatedApiAppUserWithDefaults instantiates a new PaginatedApiAppUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiAppUser) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiAppUser) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiAppUser) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiAppUser) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiAppUser) GetResults() []AppUser` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiAppUser) GetResultsOk() (*[]AppUser, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiAppUser) SetResults(v []AppUser)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiAppUser) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiAppUser) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiAppUser) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiAppUser) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiAppUser) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiAtlasCheckpoint.md b/docs/docs/PaginatedApiAtlasCheckpoint.md new file mode 100644 index 00000000..d5b47af7 --- /dev/null +++ b/docs/docs/PaginatedApiAtlasCheckpoint.md @@ -0,0 +1,108 @@ +# PaginatedApiAtlasCheckpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]Checkpoint**](Checkpoint.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiAtlasCheckpoint + +`func NewPaginatedApiAtlasCheckpoint() *PaginatedApiAtlasCheckpoint` + +NewPaginatedApiAtlasCheckpoint instantiates a new PaginatedApiAtlasCheckpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiAtlasCheckpointWithDefaults + +`func NewPaginatedApiAtlasCheckpointWithDefaults() *PaginatedApiAtlasCheckpoint` + +NewPaginatedApiAtlasCheckpointWithDefaults instantiates a new PaginatedApiAtlasCheckpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiAtlasCheckpoint) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiAtlasCheckpoint) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiAtlasCheckpoint) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiAtlasCheckpoint) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiAtlasCheckpoint) GetResults() []Checkpoint` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiAtlasCheckpoint) GetResultsOk() (*[]Checkpoint, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiAtlasCheckpoint) SetResults(v []Checkpoint)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiAtlasCheckpoint) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiAtlasCheckpoint) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiAtlasCheckpoint) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiAtlasCheckpoint) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiAtlasCheckpoint) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiAtlasDatabaseUser.md b/docs/docs/PaginatedApiAtlasDatabaseUser.md new file mode 100644 index 00000000..51d3d7f8 --- /dev/null +++ b/docs/docs/PaginatedApiAtlasDatabaseUser.md @@ -0,0 +1,108 @@ +# PaginatedApiAtlasDatabaseUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DatabaseUser**](DatabaseUser.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiAtlasDatabaseUser + +`func NewPaginatedApiAtlasDatabaseUser() *PaginatedApiAtlasDatabaseUser` + +NewPaginatedApiAtlasDatabaseUser instantiates a new PaginatedApiAtlasDatabaseUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiAtlasDatabaseUserWithDefaults + +`func NewPaginatedApiAtlasDatabaseUserWithDefaults() *PaginatedApiAtlasDatabaseUser` + +NewPaginatedApiAtlasDatabaseUserWithDefaults instantiates a new PaginatedApiAtlasDatabaseUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiAtlasDatabaseUser) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiAtlasDatabaseUser) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiAtlasDatabaseUser) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiAtlasDatabaseUser) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiAtlasDatabaseUser) GetResults() []DatabaseUser` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiAtlasDatabaseUser) GetResultsOk() (*[]DatabaseUser, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiAtlasDatabaseUser) SetResults(v []DatabaseUser)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiAtlasDatabaseUser) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiAtlasDatabaseUser) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiAtlasDatabaseUser) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiAtlasDatabaseUser) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiAtlasDatabaseUser) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiAtlasDiskBackupExportJob.md b/docs/docs/PaginatedApiAtlasDiskBackupExportJob.md new file mode 100644 index 00000000..55163213 --- /dev/null +++ b/docs/docs/PaginatedApiAtlasDiskBackupExportJob.md @@ -0,0 +1,108 @@ +# PaginatedApiAtlasDiskBackupExportJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DiskBackupExportJob**](DiskBackupExportJob.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiAtlasDiskBackupExportJob + +`func NewPaginatedApiAtlasDiskBackupExportJob() *PaginatedApiAtlasDiskBackupExportJob` + +NewPaginatedApiAtlasDiskBackupExportJob instantiates a new PaginatedApiAtlasDiskBackupExportJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiAtlasDiskBackupExportJobWithDefaults + +`func NewPaginatedApiAtlasDiskBackupExportJobWithDefaults() *PaginatedApiAtlasDiskBackupExportJob` + +NewPaginatedApiAtlasDiskBackupExportJobWithDefaults instantiates a new PaginatedApiAtlasDiskBackupExportJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiAtlasDiskBackupExportJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiAtlasDiskBackupExportJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiAtlasDiskBackupExportJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiAtlasDiskBackupExportJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiAtlasDiskBackupExportJob) GetResults() []DiskBackupExportJob` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiAtlasDiskBackupExportJob) GetResultsOk() (*[]DiskBackupExportJob, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiAtlasDiskBackupExportJob) SetResults(v []DiskBackupExportJob)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiAtlasDiskBackupExportJob) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiAtlasDiskBackupExportJob) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiAtlasDiskBackupExportJob) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiAtlasDiskBackupExportJob) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiAtlasDiskBackupExportJob) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiAtlasProviderRegions.md b/docs/docs/PaginatedApiAtlasProviderRegions.md new file mode 100644 index 00000000..94019876 --- /dev/null +++ b/docs/docs/PaginatedApiAtlasProviderRegions.md @@ -0,0 +1,108 @@ +# PaginatedApiAtlasProviderRegions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]ProviderRegions**](ProviderRegions.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiAtlasProviderRegions + +`func NewPaginatedApiAtlasProviderRegions() *PaginatedApiAtlasProviderRegions` + +NewPaginatedApiAtlasProviderRegions instantiates a new PaginatedApiAtlasProviderRegions object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiAtlasProviderRegionsWithDefaults + +`func NewPaginatedApiAtlasProviderRegionsWithDefaults() *PaginatedApiAtlasProviderRegions` + +NewPaginatedApiAtlasProviderRegionsWithDefaults instantiates a new PaginatedApiAtlasProviderRegions object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiAtlasProviderRegions) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiAtlasProviderRegions) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiAtlasProviderRegions) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiAtlasProviderRegions) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiAtlasProviderRegions) GetResults() []ProviderRegions` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiAtlasProviderRegions) GetResultsOk() (*[]ProviderRegions, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiAtlasProviderRegions) SetResults(v []ProviderRegions)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiAtlasProviderRegions) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiAtlasProviderRegions) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiAtlasProviderRegions) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiAtlasProviderRegions) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiAtlasProviderRegions) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiAtlasServerlessBackupRestoreJob.md b/docs/docs/PaginatedApiAtlasServerlessBackupRestoreJob.md new file mode 100644 index 00000000..d94d5d2d --- /dev/null +++ b/docs/docs/PaginatedApiAtlasServerlessBackupRestoreJob.md @@ -0,0 +1,108 @@ +# PaginatedApiAtlasServerlessBackupRestoreJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]ServerlessBackupRestoreJob**](ServerlessBackupRestoreJob.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiAtlasServerlessBackupRestoreJob + +`func NewPaginatedApiAtlasServerlessBackupRestoreJob() *PaginatedApiAtlasServerlessBackupRestoreJob` + +NewPaginatedApiAtlasServerlessBackupRestoreJob instantiates a new PaginatedApiAtlasServerlessBackupRestoreJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiAtlasServerlessBackupRestoreJobWithDefaults + +`func NewPaginatedApiAtlasServerlessBackupRestoreJobWithDefaults() *PaginatedApiAtlasServerlessBackupRestoreJob` + +NewPaginatedApiAtlasServerlessBackupRestoreJobWithDefaults instantiates a new PaginatedApiAtlasServerlessBackupRestoreJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) GetResults() []ServerlessBackupRestoreJob` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) GetResultsOk() (*[]ServerlessBackupRestoreJob, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) SetResults(v []ServerlessBackupRestoreJob)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiAtlasServerlessBackupRestoreJob) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiAtlasServerlessBackupSnapshot.md b/docs/docs/PaginatedApiAtlasServerlessBackupSnapshot.md new file mode 100644 index 00000000..d79e69b7 --- /dev/null +++ b/docs/docs/PaginatedApiAtlasServerlessBackupSnapshot.md @@ -0,0 +1,108 @@ +# PaginatedApiAtlasServerlessBackupSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]ServerlessBackupSnapshot**](ServerlessBackupSnapshot.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiAtlasServerlessBackupSnapshot + +`func NewPaginatedApiAtlasServerlessBackupSnapshot() *PaginatedApiAtlasServerlessBackupSnapshot` + +NewPaginatedApiAtlasServerlessBackupSnapshot instantiates a new PaginatedApiAtlasServerlessBackupSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiAtlasServerlessBackupSnapshotWithDefaults + +`func NewPaginatedApiAtlasServerlessBackupSnapshotWithDefaults() *PaginatedApiAtlasServerlessBackupSnapshot` + +NewPaginatedApiAtlasServerlessBackupSnapshotWithDefaults instantiates a new PaginatedApiAtlasServerlessBackupSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) GetResults() []ServerlessBackupSnapshot` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) GetResultsOk() (*[]ServerlessBackupSnapshot, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) SetResults(v []ServerlessBackupSnapshot)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiAtlasServerlessBackupSnapshot) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiInvoice.md b/docs/docs/PaginatedApiInvoice.md new file mode 100644 index 00000000..46747389 --- /dev/null +++ b/docs/docs/PaginatedApiInvoice.md @@ -0,0 +1,108 @@ +# PaginatedApiInvoice + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]Invoice**](Invoice.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiInvoice + +`func NewPaginatedApiInvoice() *PaginatedApiInvoice` + +NewPaginatedApiInvoice instantiates a new PaginatedApiInvoice object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiInvoiceWithDefaults + +`func NewPaginatedApiInvoiceWithDefaults() *PaginatedApiInvoice` + +NewPaginatedApiInvoiceWithDefaults instantiates a new PaginatedApiInvoice object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiInvoice) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiInvoice) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiInvoice) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiInvoice) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiInvoice) GetResults() []Invoice` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiInvoice) GetResultsOk() (*[]Invoice, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiInvoice) SetResults(v []Invoice)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiInvoice) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiInvoice) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiInvoice) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiInvoice) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiInvoice) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedApiUserAccessList.md b/docs/docs/PaginatedApiUserAccessList.md new file mode 100644 index 00000000..0ac9843e --- /dev/null +++ b/docs/docs/PaginatedApiUserAccessList.md @@ -0,0 +1,108 @@ +# PaginatedApiUserAccessList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]UserAccessList**](UserAccessList.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedApiUserAccessList + +`func NewPaginatedApiUserAccessList() *PaginatedApiUserAccessList` + +NewPaginatedApiUserAccessList instantiates a new PaginatedApiUserAccessList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedApiUserAccessListWithDefaults + +`func NewPaginatedApiUserAccessListWithDefaults() *PaginatedApiUserAccessList` + +NewPaginatedApiUserAccessListWithDefaults instantiates a new PaginatedApiUserAccessList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedApiUserAccessList) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedApiUserAccessList) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedApiUserAccessList) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedApiUserAccessList) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedApiUserAccessList) GetResults() []UserAccessList` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedApiUserAccessList) GetResultsOk() (*[]UserAccessList, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedApiUserAccessList) SetResults(v []UserAccessList)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedApiUserAccessList) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedApiUserAccessList) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedApiUserAccessList) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedApiUserAccessList) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedApiUserAccessList) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedAppUser.md b/docs/docs/PaginatedAppUser.md new file mode 100644 index 00000000..dd379084 --- /dev/null +++ b/docs/docs/PaginatedAppUser.md @@ -0,0 +1,108 @@ +# PaginatedAppUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]AppUser**](AppUser.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedAppUser + +`func NewPaginatedAppUser() *PaginatedAppUser` + +NewPaginatedAppUser instantiates a new PaginatedAppUser object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedAppUserWithDefaults + +`func NewPaginatedAppUserWithDefaults() *PaginatedAppUser` + +NewPaginatedAppUserWithDefaults instantiates a new PaginatedAppUser object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedAppUser) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedAppUser) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedAppUser) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedAppUser) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedAppUser) GetResults() []AppUser` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedAppUser) GetResultsOk() (*[]AppUser, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedAppUser) SetResults(v []AppUser)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedAppUser) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedAppUser) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedAppUser) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedAppUser) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedAppUser) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedAtlasGroup.md b/docs/docs/PaginatedAtlasGroup.md new file mode 100644 index 00000000..b006687c --- /dev/null +++ b/docs/docs/PaginatedAtlasGroup.md @@ -0,0 +1,108 @@ +# PaginatedAtlasGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]Group**](Group.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedAtlasGroup + +`func NewPaginatedAtlasGroup() *PaginatedAtlasGroup` + +NewPaginatedAtlasGroup instantiates a new PaginatedAtlasGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedAtlasGroupWithDefaults + +`func NewPaginatedAtlasGroupWithDefaults() *PaginatedAtlasGroup` + +NewPaginatedAtlasGroupWithDefaults instantiates a new PaginatedAtlasGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedAtlasGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedAtlasGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedAtlasGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedAtlasGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedAtlasGroup) GetResults() []Group` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedAtlasGroup) GetResultsOk() (*[]Group, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedAtlasGroup) SetResults(v []Group)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedAtlasGroup) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedAtlasGroup) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedAtlasGroup) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedAtlasGroup) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedAtlasGroup) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedAzurePeerNetwork.md b/docs/docs/PaginatedAzurePeerNetwork.md new file mode 100644 index 00000000..dead236f --- /dev/null +++ b/docs/docs/PaginatedAzurePeerNetwork.md @@ -0,0 +1,108 @@ +# PaginatedAzurePeerNetwork + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]AzurePeerNetwork**](AzurePeerNetwork.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedAzurePeerNetwork + +`func NewPaginatedAzurePeerNetwork() *PaginatedAzurePeerNetwork` + +NewPaginatedAzurePeerNetwork instantiates a new PaginatedAzurePeerNetwork object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedAzurePeerNetworkWithDefaults + +`func NewPaginatedAzurePeerNetworkWithDefaults() *PaginatedAzurePeerNetwork` + +NewPaginatedAzurePeerNetworkWithDefaults instantiates a new PaginatedAzurePeerNetwork object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedAzurePeerNetwork) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedAzurePeerNetwork) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedAzurePeerNetwork) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedAzurePeerNetwork) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedAzurePeerNetwork) GetResults() []AzurePeerNetwork` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedAzurePeerNetwork) GetResultsOk() (*[]AzurePeerNetwork, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedAzurePeerNetwork) SetResults(v []AzurePeerNetwork)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedAzurePeerNetwork) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedAzurePeerNetwork) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedAzurePeerNetwork) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedAzurePeerNetwork) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedAzurePeerNetwork) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedBackupSnapshot.md b/docs/docs/PaginatedBackupSnapshot.md new file mode 100644 index 00000000..54214fdf --- /dev/null +++ b/docs/docs/PaginatedBackupSnapshot.md @@ -0,0 +1,108 @@ +# PaginatedBackupSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DiskBackupSnapshot**](DiskBackupSnapshot.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedBackupSnapshot + +`func NewPaginatedBackupSnapshot() *PaginatedBackupSnapshot` + +NewPaginatedBackupSnapshot instantiates a new PaginatedBackupSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedBackupSnapshotWithDefaults + +`func NewPaginatedBackupSnapshotWithDefaults() *PaginatedBackupSnapshot` + +NewPaginatedBackupSnapshotWithDefaults instantiates a new PaginatedBackupSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedBackupSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedBackupSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedBackupSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedBackupSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedBackupSnapshot) GetResults() []DiskBackupSnapshot` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedBackupSnapshot) GetResultsOk() (*[]DiskBackupSnapshot, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedBackupSnapshot) SetResults(v []DiskBackupSnapshot)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedBackupSnapshot) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedBackupSnapshot) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedBackupSnapshot) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedBackupSnapshot) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedBackupSnapshot) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedBackupSnapshotExportBucket.md b/docs/docs/PaginatedBackupSnapshotExportBucket.md new file mode 100644 index 00000000..f05d6400 --- /dev/null +++ b/docs/docs/PaginatedBackupSnapshotExportBucket.md @@ -0,0 +1,108 @@ +# PaginatedBackupSnapshotExportBucket + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DiskBackupSnapshotAWSExportBucket**](DiskBackupSnapshotAWSExportBucket.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedBackupSnapshotExportBucket + +`func NewPaginatedBackupSnapshotExportBucket() *PaginatedBackupSnapshotExportBucket` + +NewPaginatedBackupSnapshotExportBucket instantiates a new PaginatedBackupSnapshotExportBucket object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedBackupSnapshotExportBucketWithDefaults + +`func NewPaginatedBackupSnapshotExportBucketWithDefaults() *PaginatedBackupSnapshotExportBucket` + +NewPaginatedBackupSnapshotExportBucketWithDefaults instantiates a new PaginatedBackupSnapshotExportBucket object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedBackupSnapshotExportBucket) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedBackupSnapshotExportBucket) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedBackupSnapshotExportBucket) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedBackupSnapshotExportBucket) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedBackupSnapshotExportBucket) GetResults() []DiskBackupSnapshotAWSExportBucket` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedBackupSnapshotExportBucket) GetResultsOk() (*[]DiskBackupSnapshotAWSExportBucket, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedBackupSnapshotExportBucket) SetResults(v []DiskBackupSnapshotAWSExportBucket)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedBackupSnapshotExportBucket) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedBackupSnapshotExportBucket) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedBackupSnapshotExportBucket) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedBackupSnapshotExportBucket) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedBackupSnapshotExportBucket) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedCloudBackupReplicaSet.md b/docs/docs/PaginatedCloudBackupReplicaSet.md new file mode 100644 index 00000000..c865c643 --- /dev/null +++ b/docs/docs/PaginatedCloudBackupReplicaSet.md @@ -0,0 +1,108 @@ +# PaginatedCloudBackupReplicaSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DiskBackupReplicaSet**](DiskBackupReplicaSet.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedCloudBackupReplicaSet + +`func NewPaginatedCloudBackupReplicaSet() *PaginatedCloudBackupReplicaSet` + +NewPaginatedCloudBackupReplicaSet instantiates a new PaginatedCloudBackupReplicaSet object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedCloudBackupReplicaSetWithDefaults + +`func NewPaginatedCloudBackupReplicaSetWithDefaults() *PaginatedCloudBackupReplicaSet` + +NewPaginatedCloudBackupReplicaSetWithDefaults instantiates a new PaginatedCloudBackupReplicaSet object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedCloudBackupReplicaSet) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedCloudBackupReplicaSet) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedCloudBackupReplicaSet) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedCloudBackupReplicaSet) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedCloudBackupReplicaSet) GetResults() []DiskBackupReplicaSet` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedCloudBackupReplicaSet) GetResultsOk() (*[]DiskBackupReplicaSet, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedCloudBackupReplicaSet) SetResults(v []DiskBackupReplicaSet)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedCloudBackupReplicaSet) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedCloudBackupReplicaSet) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedCloudBackupReplicaSet) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedCloudBackupReplicaSet) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedCloudBackupReplicaSet) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedCloudBackupRestoreJob.md b/docs/docs/PaginatedCloudBackupRestoreJob.md new file mode 100644 index 00000000..6a2e666b --- /dev/null +++ b/docs/docs/PaginatedCloudBackupRestoreJob.md @@ -0,0 +1,108 @@ +# PaginatedCloudBackupRestoreJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DiskBackupRestoreJob**](DiskBackupRestoreJob.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedCloudBackupRestoreJob + +`func NewPaginatedCloudBackupRestoreJob() *PaginatedCloudBackupRestoreJob` + +NewPaginatedCloudBackupRestoreJob instantiates a new PaginatedCloudBackupRestoreJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedCloudBackupRestoreJobWithDefaults + +`func NewPaginatedCloudBackupRestoreJobWithDefaults() *PaginatedCloudBackupRestoreJob` + +NewPaginatedCloudBackupRestoreJobWithDefaults instantiates a new PaginatedCloudBackupRestoreJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedCloudBackupRestoreJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedCloudBackupRestoreJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedCloudBackupRestoreJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedCloudBackupRestoreJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedCloudBackupRestoreJob) GetResults() []DiskBackupRestoreJob` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedCloudBackupRestoreJob) GetResultsOk() (*[]DiskBackupRestoreJob, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedCloudBackupRestoreJob) SetResults(v []DiskBackupRestoreJob)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedCloudBackupRestoreJob) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedCloudBackupRestoreJob) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedCloudBackupRestoreJob) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedCloudBackupRestoreJob) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedCloudBackupRestoreJob) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedCloudBackupShardedClusterSnapshot.md b/docs/docs/PaginatedCloudBackupShardedClusterSnapshot.md new file mode 100644 index 00000000..438a8858 --- /dev/null +++ b/docs/docs/PaginatedCloudBackupShardedClusterSnapshot.md @@ -0,0 +1,108 @@ +# PaginatedCloudBackupShardedClusterSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DiskBackupShardedClusterSnapshot**](DiskBackupShardedClusterSnapshot.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedCloudBackupShardedClusterSnapshot + +`func NewPaginatedCloudBackupShardedClusterSnapshot() *PaginatedCloudBackupShardedClusterSnapshot` + +NewPaginatedCloudBackupShardedClusterSnapshot instantiates a new PaginatedCloudBackupShardedClusterSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedCloudBackupShardedClusterSnapshotWithDefaults + +`func NewPaginatedCloudBackupShardedClusterSnapshotWithDefaults() *PaginatedCloudBackupShardedClusterSnapshot` + +NewPaginatedCloudBackupShardedClusterSnapshotWithDefaults instantiates a new PaginatedCloudBackupShardedClusterSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) GetResults() []DiskBackupShardedClusterSnapshot` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) GetResultsOk() (*[]DiskBackupShardedClusterSnapshot, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) SetResults(v []DiskBackupShardedClusterSnapshot)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedCloudBackupShardedClusterSnapshot) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedCloudProviderContainer.md b/docs/docs/PaginatedCloudProviderContainer.md new file mode 100644 index 00000000..ae4ff904 --- /dev/null +++ b/docs/docs/PaginatedCloudProviderContainer.md @@ -0,0 +1,108 @@ +# PaginatedCloudProviderContainer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]CloudProviderContainer**](CloudProviderContainer.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedCloudProviderContainer + +`func NewPaginatedCloudProviderContainer() *PaginatedCloudProviderContainer` + +NewPaginatedCloudProviderContainer instantiates a new PaginatedCloudProviderContainer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedCloudProviderContainerWithDefaults + +`func NewPaginatedCloudProviderContainerWithDefaults() *PaginatedCloudProviderContainer` + +NewPaginatedCloudProviderContainerWithDefaults instantiates a new PaginatedCloudProviderContainer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedCloudProviderContainer) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedCloudProviderContainer) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedCloudProviderContainer) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedCloudProviderContainer) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedCloudProviderContainer) GetResults() []CloudProviderContainer` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedCloudProviderContainer) GetResultsOk() (*[]CloudProviderContainer, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedCloudProviderContainer) SetResults(v []CloudProviderContainer)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedCloudProviderContainer) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedCloudProviderContainer) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedCloudProviderContainer) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedCloudProviderContainer) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedCloudProviderContainer) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedClusterDescriptionV15.md b/docs/docs/PaginatedClusterDescriptionV15.md new file mode 100644 index 00000000..c24b3dac --- /dev/null +++ b/docs/docs/PaginatedClusterDescriptionV15.md @@ -0,0 +1,108 @@ +# PaginatedClusterDescriptionV15 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]ClusterDescriptionV15**](ClusterDescriptionV15.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedClusterDescriptionV15 + +`func NewPaginatedClusterDescriptionV15() *PaginatedClusterDescriptionV15` + +NewPaginatedClusterDescriptionV15 instantiates a new PaginatedClusterDescriptionV15 object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedClusterDescriptionV15WithDefaults + +`func NewPaginatedClusterDescriptionV15WithDefaults() *PaginatedClusterDescriptionV15` + +NewPaginatedClusterDescriptionV15WithDefaults instantiates a new PaginatedClusterDescriptionV15 object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedClusterDescriptionV15) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedClusterDescriptionV15) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedClusterDescriptionV15) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedClusterDescriptionV15) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedClusterDescriptionV15) GetResults() []ClusterDescriptionV15` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedClusterDescriptionV15) GetResultsOk() (*[]ClusterDescriptionV15, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedClusterDescriptionV15) SetResults(v []ClusterDescriptionV15)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedClusterDescriptionV15) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedClusterDescriptionV15) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedClusterDescriptionV15) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedClusterDescriptionV15) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedClusterDescriptionV15) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedDatabase.md b/docs/docs/PaginatedDatabase.md new file mode 100644 index 00000000..b24e9e8d --- /dev/null +++ b/docs/docs/PaginatedDatabase.md @@ -0,0 +1,108 @@ +# PaginatedDatabase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]Database**](Database.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedDatabase + +`func NewPaginatedDatabase() *PaginatedDatabase` + +NewPaginatedDatabase instantiates a new PaginatedDatabase object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedDatabaseWithDefaults + +`func NewPaginatedDatabaseWithDefaults() *PaginatedDatabase` + +NewPaginatedDatabaseWithDefaults instantiates a new PaginatedDatabase object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedDatabase) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedDatabase) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedDatabase) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedDatabase) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedDatabase) GetResults() []Database` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedDatabase) GetResultsOk() (*[]Database, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedDatabase) SetResults(v []Database)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedDatabase) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedDatabase) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedDatabase) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedDatabase) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedDatabase) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedDiskPartition.md b/docs/docs/PaginatedDiskPartition.md new file mode 100644 index 00000000..ce21f1e9 --- /dev/null +++ b/docs/docs/PaginatedDiskPartition.md @@ -0,0 +1,108 @@ +# PaginatedDiskPartition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]DiskPartition**](DiskPartition.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedDiskPartition + +`func NewPaginatedDiskPartition() *PaginatedDiskPartition` + +NewPaginatedDiskPartition instantiates a new PaginatedDiskPartition object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedDiskPartitionWithDefaults + +`func NewPaginatedDiskPartitionWithDefaults() *PaginatedDiskPartition` + +NewPaginatedDiskPartitionWithDefaults instantiates a new PaginatedDiskPartition object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedDiskPartition) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedDiskPartition) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedDiskPartition) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedDiskPartition) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedDiskPartition) GetResults() []DiskPartition` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedDiskPartition) GetResultsOk() (*[]DiskPartition, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedDiskPartition) SetResults(v []DiskPartition)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedDiskPartition) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedDiskPartition) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedDiskPartition) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedDiskPartition) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedDiskPartition) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedGCPPeerVpc.md b/docs/docs/PaginatedGCPPeerVpc.md new file mode 100644 index 00000000..b63d13a5 --- /dev/null +++ b/docs/docs/PaginatedGCPPeerVpc.md @@ -0,0 +1,108 @@ +# PaginatedGCPPeerVpc + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]GCPPeerVpc**](GCPPeerVpc.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedGCPPeerVpc + +`func NewPaginatedGCPPeerVpc() *PaginatedGCPPeerVpc` + +NewPaginatedGCPPeerVpc instantiates a new PaginatedGCPPeerVpc object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedGCPPeerVpcWithDefaults + +`func NewPaginatedGCPPeerVpcWithDefaults() *PaginatedGCPPeerVpc` + +NewPaginatedGCPPeerVpcWithDefaults instantiates a new PaginatedGCPPeerVpc object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedGCPPeerVpc) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedGCPPeerVpc) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedGCPPeerVpc) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedGCPPeerVpc) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedGCPPeerVpc) GetResults() []GCPPeerVpc` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedGCPPeerVpc) GetResultsOk() (*[]GCPPeerVpc, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedGCPPeerVpc) SetResults(v []GCPPeerVpc)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedGCPPeerVpc) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedGCPPeerVpc) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedGCPPeerVpc) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedGCPPeerVpc) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedGCPPeerVpc) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedHostViewAtlas.md b/docs/docs/PaginatedHostViewAtlas.md new file mode 100644 index 00000000..e04b2217 --- /dev/null +++ b/docs/docs/PaginatedHostViewAtlas.md @@ -0,0 +1,108 @@ +# PaginatedHostViewAtlas + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]LinkAtlas**](LinkAtlas.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]HostViewAtlas**](HostViewAtlas.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedHostViewAtlas + +`func NewPaginatedHostViewAtlas() *PaginatedHostViewAtlas` + +NewPaginatedHostViewAtlas instantiates a new PaginatedHostViewAtlas object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedHostViewAtlasWithDefaults + +`func NewPaginatedHostViewAtlasWithDefaults() *PaginatedHostViewAtlas` + +NewPaginatedHostViewAtlasWithDefaults instantiates a new PaginatedHostViewAtlas object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedHostViewAtlas) GetLinks() []LinkAtlas` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedHostViewAtlas) GetLinksOk() (*[]LinkAtlas, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedHostViewAtlas) SetLinks(v []LinkAtlas)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedHostViewAtlas) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedHostViewAtlas) GetResults() []HostViewAtlas` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedHostViewAtlas) GetResultsOk() (*[]HostViewAtlas, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedHostViewAtlas) SetResults(v []HostViewAtlas)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedHostViewAtlas) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedHostViewAtlas) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedHostViewAtlas) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedHostViewAtlas) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedHostViewAtlas) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedIntegration.md b/docs/docs/PaginatedIntegration.md new file mode 100644 index 00000000..28c04948 --- /dev/null +++ b/docs/docs/PaginatedIntegration.md @@ -0,0 +1,108 @@ +# PaginatedIntegration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]Integration**](Integration.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response if **includeCount** query param is true. | [optional] [readonly] + +## Methods + +### NewPaginatedIntegration + +`func NewPaginatedIntegration() *PaginatedIntegration` + +NewPaginatedIntegration instantiates a new PaginatedIntegration object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedIntegrationWithDefaults + +`func NewPaginatedIntegrationWithDefaults() *PaginatedIntegration` + +NewPaginatedIntegrationWithDefaults instantiates a new PaginatedIntegration object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedIntegration) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedIntegration) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedIntegration) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedIntegration) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedIntegration) GetResults() []Integration` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedIntegration) GetResultsOk() (*[]Integration, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedIntegration) SetResults(v []Integration)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedIntegration) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedIntegration) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedIntegration) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedIntegration) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedIntegration) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedLegacyCluster.md b/docs/docs/PaginatedLegacyCluster.md new file mode 100644 index 00000000..a6a3d8d6 --- /dev/null +++ b/docs/docs/PaginatedLegacyCluster.md @@ -0,0 +1,108 @@ +# PaginatedLegacyCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]LegacyClusterDescription**](LegacyClusterDescription.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedLegacyCluster + +`func NewPaginatedLegacyCluster() *PaginatedLegacyCluster` + +NewPaginatedLegacyCluster instantiates a new PaginatedLegacyCluster object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedLegacyClusterWithDefaults + +`func NewPaginatedLegacyClusterWithDefaults() *PaginatedLegacyCluster` + +NewPaginatedLegacyClusterWithDefaults instantiates a new PaginatedLegacyCluster object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedLegacyCluster) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedLegacyCluster) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedLegacyCluster) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedLegacyCluster) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedLegacyCluster) GetResults() []LegacyClusterDescription` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedLegacyCluster) GetResultsOk() (*[]LegacyClusterDescription, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedLegacyCluster) SetResults(v []LegacyClusterDescription)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedLegacyCluster) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedLegacyCluster) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedLegacyCluster) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedLegacyCluster) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedLegacyCluster) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedNetworkAccess.md b/docs/docs/PaginatedNetworkAccess.md new file mode 100644 index 00000000..858072a0 --- /dev/null +++ b/docs/docs/PaginatedNetworkAccess.md @@ -0,0 +1,108 @@ +# PaginatedNetworkAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]NetworkPermissionEntry**](NetworkPermissionEntry.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedNetworkAccess + +`func NewPaginatedNetworkAccess() *PaginatedNetworkAccess` + +NewPaginatedNetworkAccess instantiates a new PaginatedNetworkAccess object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedNetworkAccessWithDefaults + +`func NewPaginatedNetworkAccessWithDefaults() *PaginatedNetworkAccess` + +NewPaginatedNetworkAccessWithDefaults instantiates a new PaginatedNetworkAccess object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedNetworkAccess) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedNetworkAccess) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedNetworkAccess) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedNetworkAccess) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedNetworkAccess) GetResults() []NetworkPermissionEntry` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedNetworkAccess) GetResultsOk() (*[]NetworkPermissionEntry, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedNetworkAccess) SetResults(v []NetworkPermissionEntry)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedNetworkAccess) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedNetworkAccess) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedNetworkAccess) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedNetworkAccess) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedNetworkAccess) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedOnlineArchive.md b/docs/docs/PaginatedOnlineArchive.md new file mode 100644 index 00000000..29932b4f --- /dev/null +++ b/docs/docs/PaginatedOnlineArchive.md @@ -0,0 +1,108 @@ +# PaginatedOnlineArchive + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]OnlineArchive**](OnlineArchive.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedOnlineArchive + +`func NewPaginatedOnlineArchive() *PaginatedOnlineArchive` + +NewPaginatedOnlineArchive instantiates a new PaginatedOnlineArchive object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedOnlineArchiveWithDefaults + +`func NewPaginatedOnlineArchiveWithDefaults() *PaginatedOnlineArchive` + +NewPaginatedOnlineArchiveWithDefaults instantiates a new PaginatedOnlineArchive object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedOnlineArchive) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedOnlineArchive) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedOnlineArchive) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedOnlineArchive) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedOnlineArchive) GetResults() []OnlineArchive` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedOnlineArchive) GetResultsOk() (*[]OnlineArchive, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedOnlineArchive) SetResults(v []OnlineArchive)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedOnlineArchive) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedOnlineArchive) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedOnlineArchive) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedOnlineArchive) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedOnlineArchive) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedOrgGroup.md b/docs/docs/PaginatedOrgGroup.md new file mode 100644 index 00000000..8f2d1825 --- /dev/null +++ b/docs/docs/PaginatedOrgGroup.md @@ -0,0 +1,108 @@ +# PaginatedOrgGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]OrgGroup**](OrgGroup.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedOrgGroup + +`func NewPaginatedOrgGroup() *PaginatedOrgGroup` + +NewPaginatedOrgGroup instantiates a new PaginatedOrgGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedOrgGroupWithDefaults + +`func NewPaginatedOrgGroupWithDefaults() *PaginatedOrgGroup` + +NewPaginatedOrgGroupWithDefaults instantiates a new PaginatedOrgGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedOrgGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedOrgGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedOrgGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedOrgGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedOrgGroup) GetResults() []OrgGroup` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedOrgGroup) GetResultsOk() (*[]OrgGroup, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedOrgGroup) SetResults(v []OrgGroup)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedOrgGroup) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedOrgGroup) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedOrgGroup) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedOrgGroup) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedOrgGroup) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedOrganization.md b/docs/docs/PaginatedOrganization.md new file mode 100644 index 00000000..02dc1c85 --- /dev/null +++ b/docs/docs/PaginatedOrganization.md @@ -0,0 +1,108 @@ +# PaginatedOrganization + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]Organization**](Organization.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedOrganization + +`func NewPaginatedOrganization() *PaginatedOrganization` + +NewPaginatedOrganization instantiates a new PaginatedOrganization object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedOrganizationWithDefaults + +`func NewPaginatedOrganizationWithDefaults() *PaginatedOrganization` + +NewPaginatedOrganizationWithDefaults instantiates a new PaginatedOrganization object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedOrganization) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedOrganization) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedOrganization) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedOrganization) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedOrganization) GetResults() []Organization` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedOrganization) GetResultsOk() (*[]Organization, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedOrganization) SetResults(v []Organization)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedOrganization) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedOrganization) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedOrganization) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedOrganization) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedOrganization) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedPipelineRun.md b/docs/docs/PaginatedPipelineRun.md new file mode 100644 index 00000000..417df9d1 --- /dev/null +++ b/docs/docs/PaginatedPipelineRun.md @@ -0,0 +1,108 @@ +# PaginatedPipelineRun + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]IngestionPipelineRun**](IngestionPipelineRun.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedPipelineRun + +`func NewPaginatedPipelineRun() *PaginatedPipelineRun` + +NewPaginatedPipelineRun instantiates a new PaginatedPipelineRun object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedPipelineRunWithDefaults + +`func NewPaginatedPipelineRunWithDefaults() *PaginatedPipelineRun` + +NewPaginatedPipelineRunWithDefaults instantiates a new PaginatedPipelineRun object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedPipelineRun) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedPipelineRun) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedPipelineRun) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedPipelineRun) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedPipelineRun) GetResults() []IngestionPipelineRun` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedPipelineRun) GetResultsOk() (*[]IngestionPipelineRun, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedPipelineRun) SetResults(v []IngestionPipelineRun)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedPipelineRun) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedPipelineRun) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedPipelineRun) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedPipelineRun) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedPipelineRun) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedPrivateLinkConnection.md b/docs/docs/PaginatedPrivateLinkConnection.md new file mode 100644 index 00000000..dfdd5363 --- /dev/null +++ b/docs/docs/PaginatedPrivateLinkConnection.md @@ -0,0 +1,108 @@ +# PaginatedPrivateLinkConnection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]EndpointService**](EndpointService.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedPrivateLinkConnection + +`func NewPaginatedPrivateLinkConnection() *PaginatedPrivateLinkConnection` + +NewPaginatedPrivateLinkConnection instantiates a new PaginatedPrivateLinkConnection object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedPrivateLinkConnectionWithDefaults + +`func NewPaginatedPrivateLinkConnectionWithDefaults() *PaginatedPrivateLinkConnection` + +NewPaginatedPrivateLinkConnectionWithDefaults instantiates a new PaginatedPrivateLinkConnection object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedPrivateLinkConnection) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedPrivateLinkConnection) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedPrivateLinkConnection) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedPrivateLinkConnection) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedPrivateLinkConnection) GetResults() []EndpointService` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedPrivateLinkConnection) GetResultsOk() (*[]EndpointService, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedPrivateLinkConnection) SetResults(v []EndpointService)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedPrivateLinkConnection) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedPrivateLinkConnection) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedPrivateLinkConnection) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedPrivateLinkConnection) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedPrivateLinkConnection) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedRestoreJob.md b/docs/docs/PaginatedRestoreJob.md new file mode 100644 index 00000000..e32d16bd --- /dev/null +++ b/docs/docs/PaginatedRestoreJob.md @@ -0,0 +1,108 @@ +# PaginatedRestoreJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]RestoreJob**](RestoreJob.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedRestoreJob + +`func NewPaginatedRestoreJob() *PaginatedRestoreJob` + +NewPaginatedRestoreJob instantiates a new PaginatedRestoreJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedRestoreJobWithDefaults + +`func NewPaginatedRestoreJobWithDefaults() *PaginatedRestoreJob` + +NewPaginatedRestoreJobWithDefaults instantiates a new PaginatedRestoreJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedRestoreJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedRestoreJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedRestoreJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedRestoreJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedRestoreJob) GetResults() []RestoreJob` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedRestoreJob) GetResultsOk() (*[]RestoreJob, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedRestoreJob) SetResults(v []RestoreJob)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedRestoreJob) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedRestoreJob) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedRestoreJob) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedRestoreJob) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedRestoreJob) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedServerlessInstanceDescription.md b/docs/docs/PaginatedServerlessInstanceDescription.md new file mode 100644 index 00000000..70aa8813 --- /dev/null +++ b/docs/docs/PaginatedServerlessInstanceDescription.md @@ -0,0 +1,108 @@ +# PaginatedServerlessInstanceDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]ServerlessInstanceDescription**](ServerlessInstanceDescription.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedServerlessInstanceDescription + +`func NewPaginatedServerlessInstanceDescription() *PaginatedServerlessInstanceDescription` + +NewPaginatedServerlessInstanceDescription instantiates a new PaginatedServerlessInstanceDescription object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedServerlessInstanceDescriptionWithDefaults + +`func NewPaginatedServerlessInstanceDescriptionWithDefaults() *PaginatedServerlessInstanceDescription` + +NewPaginatedServerlessInstanceDescriptionWithDefaults instantiates a new PaginatedServerlessInstanceDescription object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedServerlessInstanceDescription) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedServerlessInstanceDescription) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedServerlessInstanceDescription) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedServerlessInstanceDescription) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedServerlessInstanceDescription) GetResults() []ServerlessInstanceDescription` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedServerlessInstanceDescription) GetResultsOk() (*[]ServerlessInstanceDescription, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedServerlessInstanceDescription) SetResults(v []ServerlessInstanceDescription)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedServerlessInstanceDescription) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedServerlessInstanceDescription) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedServerlessInstanceDescription) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedServerlessInstanceDescription) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedServerlessInstanceDescription) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedSnapshot.md b/docs/docs/PaginatedSnapshot.md new file mode 100644 index 00000000..5190d53f --- /dev/null +++ b/docs/docs/PaginatedSnapshot.md @@ -0,0 +1,108 @@ +# PaginatedSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]Snapshot**](Snapshot.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedSnapshot + +`func NewPaginatedSnapshot() *PaginatedSnapshot` + +NewPaginatedSnapshot instantiates a new PaginatedSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedSnapshotWithDefaults + +`func NewPaginatedSnapshotWithDefaults() *PaginatedSnapshot` + +NewPaginatedSnapshotWithDefaults instantiates a new PaginatedSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedSnapshot) GetResults() []Snapshot` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedSnapshot) GetResultsOk() (*[]Snapshot, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedSnapshot) SetResults(v []Snapshot)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedSnapshot) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedSnapshot) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedSnapshot) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedSnapshot) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedSnapshot) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedTeam.md b/docs/docs/PaginatedTeam.md new file mode 100644 index 00000000..e8ba86c5 --- /dev/null +++ b/docs/docs/PaginatedTeam.md @@ -0,0 +1,108 @@ +# PaginatedTeam + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]TeamResponse**](TeamResponse.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedTeam + +`func NewPaginatedTeam() *PaginatedTeam` + +NewPaginatedTeam instantiates a new PaginatedTeam object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedTeamWithDefaults + +`func NewPaginatedTeamWithDefaults() *PaginatedTeam` + +NewPaginatedTeamWithDefaults instantiates a new PaginatedTeam object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedTeam) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedTeam) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedTeam) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedTeam) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedTeam) GetResults() []TeamResponse` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedTeam) GetResultsOk() (*[]TeamResponse, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedTeam) SetResults(v []TeamResponse)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedTeam) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedTeam) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedTeam) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedTeam) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedTeam) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedTeamRole.md b/docs/docs/PaginatedTeamRole.md new file mode 100644 index 00000000..32ec54e6 --- /dev/null +++ b/docs/docs/PaginatedTeamRole.md @@ -0,0 +1,108 @@ +# PaginatedTeamRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]TeamRole**](TeamRole.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedTeamRole + +`func NewPaginatedTeamRole() *PaginatedTeamRole` + +NewPaginatedTeamRole instantiates a new PaginatedTeamRole object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedTeamRoleWithDefaults + +`func NewPaginatedTeamRoleWithDefaults() *PaginatedTeamRole` + +NewPaginatedTeamRoleWithDefaults instantiates a new PaginatedTeamRole object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedTeamRole) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedTeamRole) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedTeamRole) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedTeamRole) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedTeamRole) GetResults() []TeamRole` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedTeamRole) GetResultsOk() (*[]TeamRole, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedTeamRole) SetResults(v []TeamRole)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedTeamRole) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedTeamRole) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedTeamRole) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedTeamRole) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedTeamRole) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedTenantRestore.md b/docs/docs/PaginatedTenantRestore.md new file mode 100644 index 00000000..4ac19cf5 --- /dev/null +++ b/docs/docs/PaginatedTenantRestore.md @@ -0,0 +1,108 @@ +# PaginatedTenantRestore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]TenantRestore**](TenantRestore.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedTenantRestore + +`func NewPaginatedTenantRestore() *PaginatedTenantRestore` + +NewPaginatedTenantRestore instantiates a new PaginatedTenantRestore object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedTenantRestoreWithDefaults + +`func NewPaginatedTenantRestoreWithDefaults() *PaginatedTenantRestore` + +NewPaginatedTenantRestoreWithDefaults instantiates a new PaginatedTenantRestore object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedTenantRestore) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedTenantRestore) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedTenantRestore) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedTenantRestore) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedTenantRestore) GetResults() []TenantRestore` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedTenantRestore) GetResultsOk() (*[]TenantRestore, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedTenantRestore) SetResults(v []TenantRestore)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedTenantRestore) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedTenantRestore) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedTenantRestore) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedTenantRestore) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedTenantRestore) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedTenantSnapshot.md b/docs/docs/PaginatedTenantSnapshot.md new file mode 100644 index 00000000..9d612d76 --- /dev/null +++ b/docs/docs/PaginatedTenantSnapshot.md @@ -0,0 +1,108 @@ +# PaginatedTenantSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]TenantSnapshot**](TenantSnapshot.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedTenantSnapshot + +`func NewPaginatedTenantSnapshot() *PaginatedTenantSnapshot` + +NewPaginatedTenantSnapshot instantiates a new PaginatedTenantSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedTenantSnapshotWithDefaults + +`func NewPaginatedTenantSnapshotWithDefaults() *PaginatedTenantSnapshot` + +NewPaginatedTenantSnapshotWithDefaults instantiates a new PaginatedTenantSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedTenantSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedTenantSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedTenantSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedTenantSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedTenantSnapshot) GetResults() []TenantSnapshot` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedTenantSnapshot) GetResultsOk() (*[]TenantSnapshot, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedTenantSnapshot) SetResults(v []TenantSnapshot)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedTenantSnapshot) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedTenantSnapshot) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedTenantSnapshot) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedTenantSnapshot) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedTenantSnapshot) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PaginatedUserCert.md b/docs/docs/PaginatedUserCert.md new file mode 100644 index 00000000..49e9b82a --- /dev/null +++ b/docs/docs/PaginatedUserCert.md @@ -0,0 +1,108 @@ +# PaginatedUserCert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Results** | Pointer to [**[]UserCert**](UserCert.md) | List of returned documents that MongoDB Cloud providers when completing this request. | [optional] [readonly] +**TotalCount** | Pointer to **int** | Number of documents returned in this response. | [optional] [readonly] + +## Methods + +### NewPaginatedUserCert + +`func NewPaginatedUserCert() *PaginatedUserCert` + +NewPaginatedUserCert instantiates a new PaginatedUserCert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaginatedUserCertWithDefaults + +`func NewPaginatedUserCertWithDefaults() *PaginatedUserCert` + +NewPaginatedUserCertWithDefaults instantiates a new PaginatedUserCert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *PaginatedUserCert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *PaginatedUserCert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *PaginatedUserCert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *PaginatedUserCert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetResults + +`func (o *PaginatedUserCert) GetResults() []UserCert` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PaginatedUserCert) GetResultsOk() (*[]UserCert, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PaginatedUserCert) SetResults(v []UserCert)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PaginatedUserCert) HasResults() bool` + +HasResults returns a boolean if a field has been set. + +### GetTotalCount + +`func (o *PaginatedUserCert) GetTotalCount() int` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *PaginatedUserCert) GetTotalCountOk() (*int, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *PaginatedUserCert) SetTotalCount(v int)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *PaginatedUserCert) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PartitionField.md b/docs/docs/PartitionField.md new file mode 100644 index 00000000..40b262b7 --- /dev/null +++ b/docs/docs/PartitionField.md @@ -0,0 +1,98 @@ +# PartitionField + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FieldName** | **string** | Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation. | +**FieldType** | Pointer to **string** | Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3. | [optional] [readonly] +**Order** | **int** | Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence. | [default to 0] + +## Methods + +### NewPartitionField + +`func NewPartitionField(fieldName string, order int, ) *PartitionField` + +NewPartitionField instantiates a new PartitionField object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPartitionFieldWithDefaults + +`func NewPartitionFieldWithDefaults() *PartitionField` + +NewPartitionFieldWithDefaults instantiates a new PartitionField object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFieldName + +`func (o *PartitionField) GetFieldName() string` + +GetFieldName returns the FieldName field if non-nil, zero value otherwise. + +### GetFieldNameOk + +`func (o *PartitionField) GetFieldNameOk() (*string, bool)` + +GetFieldNameOk returns a tuple with the FieldName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFieldName + +`func (o *PartitionField) SetFieldName(v string)` + +SetFieldName sets FieldName field to given value. + + +### GetFieldType + +`func (o *PartitionField) GetFieldType() string` + +GetFieldType returns the FieldType field if non-nil, zero value otherwise. + +### GetFieldTypeOk + +`func (o *PartitionField) GetFieldTypeOk() (*string, bool)` + +GetFieldTypeOk returns a tuple with the FieldType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFieldType + +`func (o *PartitionField) SetFieldType(v string)` + +SetFieldType sets FieldType field to given value. + +### HasFieldType + +`func (o *PartitionField) HasFieldType() bool` + +HasFieldType returns a boolean if a field has been set. + +### GetOrder + +`func (o *PartitionField) GetOrder() int` + +GetOrder returns the Order field if non-nil, zero value otherwise. + +### GetOrderOk + +`func (o *PartitionField) GetOrderOk() (*int, bool)` + +GetOrderOk returns a tuple with the Order field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrder + +`func (o *PartitionField) SetOrder(v int)` + +SetOrder sets Order field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Payment.md b/docs/docs/Payment.md new file mode 100644 index 00000000..fe27d846 --- /dev/null +++ b/docs/docs/Payment.md @@ -0,0 +1,238 @@ +# Payment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AmountBilledCents** | Pointer to **int64** | Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar) and calculates its value as **subtotalCents** + **salesTaxCents** - **startingBalanceCents**. | [optional] [readonly] +**AmountPaidCents** | Pointer to **int64** | Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar). | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice. | [optional] [readonly] +**SalesTaxCents** | Pointer to **int64** | Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar). | [optional] [readonly] +**StatusName** | Pointer to **string** | Phase of payment processing for the associated invoice when you made this request. These phases include: | Phase Value | Reason | |---|---| | `CANCELLED` | Customer or MongoDB cancelled the payment. | | `ERROR` | Issue arose when attempting to complete payment. | | `FAILED` | MongoDB tried to charge the credit card without success. | | `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. | | `FORGIVEN` | Customer initiated payment which MongoDB later forgave. | | `INVOICED` | MongoDB issued an invoice that included this line item. | | `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. | | `PAID` | Customer submitted a successful payment. | | `PARTIAL_PAID` | Customer paid for part of this line item. | | [optional] +**SubtotalCents** | Pointer to **int64** | Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar). | [optional] [readonly] +**Updated** | Pointer to **time.Time** | Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewPayment + +`func NewPayment() *Payment` + +NewPayment instantiates a new Payment object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPaymentWithDefaults + +`func NewPaymentWithDefaults() *Payment` + +NewPaymentWithDefaults instantiates a new Payment object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAmountBilledCents + +`func (o *Payment) GetAmountBilledCents() int64` + +GetAmountBilledCents returns the AmountBilledCents field if non-nil, zero value otherwise. + +### GetAmountBilledCentsOk + +`func (o *Payment) GetAmountBilledCentsOk() (*int64, bool)` + +GetAmountBilledCentsOk returns a tuple with the AmountBilledCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmountBilledCents + +`func (o *Payment) SetAmountBilledCents(v int64)` + +SetAmountBilledCents sets AmountBilledCents field to given value. + +### HasAmountBilledCents + +`func (o *Payment) HasAmountBilledCents() bool` + +HasAmountBilledCents returns a boolean if a field has been set. + +### GetAmountPaidCents + +`func (o *Payment) GetAmountPaidCents() int64` + +GetAmountPaidCents returns the AmountPaidCents field if non-nil, zero value otherwise. + +### GetAmountPaidCentsOk + +`func (o *Payment) GetAmountPaidCentsOk() (*int64, bool)` + +GetAmountPaidCentsOk returns a tuple with the AmountPaidCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmountPaidCents + +`func (o *Payment) SetAmountPaidCents(v int64)` + +SetAmountPaidCents sets AmountPaidCents field to given value. + +### HasAmountPaidCents + +`func (o *Payment) HasAmountPaidCents() bool` + +HasAmountPaidCents returns a boolean if a field has been set. + +### GetCreated + +`func (o *Payment) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Payment) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Payment) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Payment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetId + +`func (o *Payment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Payment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Payment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Payment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSalesTaxCents + +`func (o *Payment) GetSalesTaxCents() int64` + +GetSalesTaxCents returns the SalesTaxCents field if non-nil, zero value otherwise. + +### GetSalesTaxCentsOk + +`func (o *Payment) GetSalesTaxCentsOk() (*int64, bool)` + +GetSalesTaxCentsOk returns a tuple with the SalesTaxCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSalesTaxCents + +`func (o *Payment) SetSalesTaxCents(v int64)` + +SetSalesTaxCents sets SalesTaxCents field to given value. + +### HasSalesTaxCents + +`func (o *Payment) HasSalesTaxCents() bool` + +HasSalesTaxCents returns a boolean if a field has been set. + +### GetStatusName + +`func (o *Payment) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *Payment) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *Payment) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *Payment) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetSubtotalCents + +`func (o *Payment) GetSubtotalCents() int64` + +GetSubtotalCents returns the SubtotalCents field if non-nil, zero value otherwise. + +### GetSubtotalCentsOk + +`func (o *Payment) GetSubtotalCentsOk() (*int64, bool)` + +GetSubtotalCentsOk returns a tuple with the SubtotalCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtotalCents + +`func (o *Payment) SetSubtotalCents(v int64)` + +SetSubtotalCents sets SubtotalCents field to given value. + +### HasSubtotalCents + +`func (o *Payment) HasSubtotalCents() bool` + +HasSubtotalCents returns a boolean if a field has been set. + +### GetUpdated + +`func (o *Payment) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *Payment) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *Payment) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *Payment) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PemFileInfo.md b/docs/docs/PemFileInfo.md new file mode 100644 index 00000000..c267d2ab --- /dev/null +++ b/docs/docs/PemFileInfo.md @@ -0,0 +1,82 @@ +# PemFileInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Certificates** | Pointer to [**[]X509Certificate**](X509Certificate.md) | | [optional] +**FileName** | Pointer to **string** | | [optional] + +## Methods + +### NewPemFileInfo + +`func NewPemFileInfo() *PemFileInfo` + +NewPemFileInfo instantiates a new PemFileInfo object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPemFileInfoWithDefaults + +`func NewPemFileInfoWithDefaults() *PemFileInfo` + +NewPemFileInfoWithDefaults instantiates a new PemFileInfo object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCertificates + +`func (o *PemFileInfo) GetCertificates() []X509Certificate` + +GetCertificates returns the Certificates field if non-nil, zero value otherwise. + +### GetCertificatesOk + +`func (o *PemFileInfo) GetCertificatesOk() (*[]X509Certificate, bool)` + +GetCertificatesOk returns a tuple with the Certificates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificates + +`func (o *PemFileInfo) SetCertificates(v []X509Certificate)` + +SetCertificates sets Certificates field to given value. + +### HasCertificates + +`func (o *PemFileInfo) HasCertificates() bool` + +HasCertificates returns a boolean if a field has been set. + +### GetFileName + +`func (o *PemFileInfo) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *PemFileInfo) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *PemFileInfo) SetFileName(v string)` + +SetFileName sets FileName field to given value. + +### HasFileName + +`func (o *PemFileInfo) HasFileName() bool` + +HasFileName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PemFileInfoView.md b/docs/docs/PemFileInfoView.md new file mode 100644 index 00000000..9106642d --- /dev/null +++ b/docs/docs/PemFileInfoView.md @@ -0,0 +1,82 @@ +# PemFileInfoView + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Certificates** | Pointer to [**[]X509Certificate**](X509Certificate.md) | List of certificates in the file. | [optional] +**FileName** | Pointer to **string** | Human-readable label given to the file. | [optional] + +## Methods + +### NewPemFileInfoView + +`func NewPemFileInfoView() *PemFileInfoView` + +NewPemFileInfoView instantiates a new PemFileInfoView object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPemFileInfoViewWithDefaults + +`func NewPemFileInfoViewWithDefaults() *PemFileInfoView` + +NewPemFileInfoViewWithDefaults instantiates a new PemFileInfoView object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCertificates + +`func (o *PemFileInfoView) GetCertificates() []X509Certificate` + +GetCertificates returns the Certificates field if non-nil, zero value otherwise. + +### GetCertificatesOk + +`func (o *PemFileInfoView) GetCertificatesOk() (*[]X509Certificate, bool)` + +GetCertificatesOk returns a tuple with the Certificates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificates + +`func (o *PemFileInfoView) SetCertificates(v []X509Certificate)` + +SetCertificates sets Certificates field to given value. + +### HasCertificates + +`func (o *PemFileInfoView) HasCertificates() bool` + +HasCertificates returns a boolean if a field has been set. + +### GetFileName + +`func (o *PemFileInfoView) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *PemFileInfoView) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *PemFileInfoView) SetFileName(v string)` + +SetFileName sets FileName field to given value. + +### HasFileName + +`func (o *PemFileInfoView) HasFileName() bool` + +HasFileName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PerformanceAdvisorApi.md b/docs/docs/PerformanceAdvisorApi.md new file mode 100644 index 00000000..f56fb1ce --- /dev/null +++ b/docs/docs/PerformanceAdvisorApi.md @@ -0,0 +1,416 @@ +# \PerformanceAdvisorApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**DisableSlowOperationThresholding**](PerformanceAdvisorApi.md#DisableSlowOperationThresholding) | **Delete** /api/atlas/v2/groups/{groupId}/managedSlowMs/disable | Disable Managed Slow Operation Threshold +[**EnableSlowOperationThresholding**](PerformanceAdvisorApi.md#EnableSlowOperationThresholding) | **Post** /api/atlas/v2/groups/{groupId}/managedSlowMs/enable | Enable Managed Slow Operation Threshold +[**ListSlowQueries**](PerformanceAdvisorApi.md#ListSlowQueries) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs | Return Slow Queries +[**ListSlowQueryNamespaces**](PerformanceAdvisorApi.md#ListSlowQueryNamespaces) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces | Return All Namespaces for One Host +[**ListSuggestedIndexes**](PerformanceAdvisorApi.md#ListSuggestedIndexes) | **Get** /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes | Return Suggested Indexes + + + +## DisableSlowOperationThresholding + +> DisableSlowOperationThresholding(ctx, groupId).Execute() + +Disable Managed Slow Operation Threshold + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.PerformanceAdvisorApi.DisableSlowOperationThresholding(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorApi.DisableSlowOperationThresholding``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableSlowOperationThresholdingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## EnableSlowOperationThresholding + +> EnableSlowOperationThresholding(ctx, groupId).Execute() + +Enable Managed Slow Operation Threshold + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.PerformanceAdvisorApi.EnableSlowOperationThresholding(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorApi.EnableSlowOperationThresholding``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableSlowOperationThresholdingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListSlowQueries + +> PerformanceAdvisorSlowQueryList ListSlowQueries(ctx, groupId, processId).Duration(duration).Namespaces(namespaces).NLogs(nLogs).Since(since).Execute() + +Return Slow Queries + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "processId_example" // string | + duration := int64(789) // int64 | (optional) + namespaces := []string{"Inner_example"} // []string | (optional) + nLogs := int64(789) // int64 | (optional) (default to 20000) + since := int64(789) // int64 | (optional) + + resp, r, err := sdk.PerformanceAdvisorApi.ListSlowQueries(context.Background(), groupId, processId).Duration(duration).Namespaces(namespaces).NLogs(nLogs).Since(since).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorApi.ListSlowQueries``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListSlowQueries`: PerformanceAdvisorSlowQueryList + fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorApi.ListSlowQueries`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSlowQueriesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **duration** | **int64** | Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. | + **namespaces** | **[]string** | Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `<database>.<collection>`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. | + **nLogs** | **int64** | Maximum number of lines from the log to return. | [default to 20000] + **since** | **int64** | Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. | + +### Return type + +[**PerformanceAdvisorSlowQueryList**](PerformanceAdvisorSlowQueryList.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListSlowQueryNamespaces + +> Namespaces ListSlowQueryNamespaces(ctx, groupId, processId).Duration(duration).Since(since).Execute() + +Return All Namespaces for One Host + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "processId_example" // string | + duration := int64(789) // int64 | (optional) + since := int64(789) // int64 | (optional) + + resp, r, err := sdk.PerformanceAdvisorApi.ListSlowQueryNamespaces(context.Background(), groupId, processId).Duration(duration).Since(since).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorApi.ListSlowQueryNamespaces``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListSlowQueryNamespaces`: Namespaces + fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorApi.ListSlowQueryNamespaces`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSlowQueryNamespacesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **duration** | **int64** | Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. | + **since** | **int64** | Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. | + +### Return type + +[**Namespaces**](Namespaces.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListSuggestedIndexes + +> PerformanceAdvisorResponse ListSuggestedIndexes(ctx, groupId, processId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Duration(duration).Namespaces(namespaces).NExamples(nExamples).NIndexes(nIndexes).Since(since).Execute() + +Return Suggested Indexes + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + processId := "processId_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + duration := float32(8.14) // float32 | (optional) + namespaces := []string{"Inner_example"} // []string | (optional) + nExamples := int64(789) // int64 | (optional) (default to 5) + nIndexes := int64(789) // int64 | (optional) + since := float32(8.14) // float32 | (optional) + + resp, r, err := sdk.PerformanceAdvisorApi.ListSuggestedIndexes(context.Background(), groupId, processId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Duration(duration).Namespaces(namespaces).NExamples(nExamples).NIndexes(nIndexes).Since(since).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PerformanceAdvisorApi.ListSuggestedIndexes``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListSuggestedIndexes`: PerformanceAdvisorResponse + fmt.Fprintf(os.Stdout, "Response from `PerformanceAdvisorApi.ListSuggestedIndexes`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**processId** | **string** | Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSuggestedIndexesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **duration** | **float32** | Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. - If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time. - If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours. | + **namespaces** | **[]string** | Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `<database>.<collection>`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces. | + **nExamples** | **int64** | Maximum number of example queries that benefit from the suggested index. | [default to 5] + **nIndexes** | **int64** | Number that indicates the maximum indexes to suggest. | + **since** | **float32** | Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). - If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time. - If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours. | + +### Return type + +[**PerformanceAdvisorResponse**](PerformanceAdvisorResponse.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/PerformanceAdvisorIndex.md b/docs/docs/PerformanceAdvisorIndex.md new file mode 100644 index 00000000..965605fd --- /dev/null +++ b/docs/docs/PerformanceAdvisorIndex.md @@ -0,0 +1,186 @@ +# PerformanceAdvisorIndex + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AvgObjSize** | Pointer to **float64** | The average size of an object in the collection of this index. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this index. | [optional] [readonly] +**Impact** | Pointer to **[]string** | List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests. | [optional] [readonly] +**Index** | Pointer to **[]map[string]string** | List that contains documents that specify a key in the index and its sort order. | [optional] [readonly] +**Namespace** | Pointer to **string** | Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `<database>.<collection>`. | [optional] [readonly] +**Weight** | Pointer to **float64** | Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface. | [optional] [readonly] + +## Methods + +### NewPerformanceAdvisorIndex + +`func NewPerformanceAdvisorIndex() *PerformanceAdvisorIndex` + +NewPerformanceAdvisorIndex instantiates a new PerformanceAdvisorIndex object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPerformanceAdvisorIndexWithDefaults + +`func NewPerformanceAdvisorIndexWithDefaults() *PerformanceAdvisorIndex` + +NewPerformanceAdvisorIndexWithDefaults instantiates a new PerformanceAdvisorIndex object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAvgObjSize + +`func (o *PerformanceAdvisorIndex) GetAvgObjSize() float64` + +GetAvgObjSize returns the AvgObjSize field if non-nil, zero value otherwise. + +### GetAvgObjSizeOk + +`func (o *PerformanceAdvisorIndex) GetAvgObjSizeOk() (*float64, bool)` + +GetAvgObjSizeOk returns a tuple with the AvgObjSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvgObjSize + +`func (o *PerformanceAdvisorIndex) SetAvgObjSize(v float64)` + +SetAvgObjSize sets AvgObjSize field to given value. + +### HasAvgObjSize + +`func (o *PerformanceAdvisorIndex) HasAvgObjSize() bool` + +HasAvgObjSize returns a boolean if a field has been set. + +### GetId + +`func (o *PerformanceAdvisorIndex) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PerformanceAdvisorIndex) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PerformanceAdvisorIndex) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PerformanceAdvisorIndex) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetImpact + +`func (o *PerformanceAdvisorIndex) GetImpact() []string` + +GetImpact returns the Impact field if non-nil, zero value otherwise. + +### GetImpactOk + +`func (o *PerformanceAdvisorIndex) GetImpactOk() (*[]string, bool)` + +GetImpactOk returns a tuple with the Impact field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImpact + +`func (o *PerformanceAdvisorIndex) SetImpact(v []string)` + +SetImpact sets Impact field to given value. + +### HasImpact + +`func (o *PerformanceAdvisorIndex) HasImpact() bool` + +HasImpact returns a boolean if a field has been set. + +### GetIndex + +`func (o *PerformanceAdvisorIndex) GetIndex() []map[string]string` + +GetIndex returns the Index field if non-nil, zero value otherwise. + +### GetIndexOk + +`func (o *PerformanceAdvisorIndex) GetIndexOk() (*[]map[string]string, bool)` + +GetIndexOk returns a tuple with the Index field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndex + +`func (o *PerformanceAdvisorIndex) SetIndex(v []map[string]string)` + +SetIndex sets Index field to given value. + +### HasIndex + +`func (o *PerformanceAdvisorIndex) HasIndex() bool` + +HasIndex returns a boolean if a field has been set. + +### GetNamespace + +`func (o *PerformanceAdvisorIndex) GetNamespace() string` + +GetNamespace returns the Namespace field if non-nil, zero value otherwise. + +### GetNamespaceOk + +`func (o *PerformanceAdvisorIndex) GetNamespaceOk() (*string, bool)` + +GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNamespace + +`func (o *PerformanceAdvisorIndex) SetNamespace(v string)` + +SetNamespace sets Namespace field to given value. + +### HasNamespace + +`func (o *PerformanceAdvisorIndex) HasNamespace() bool` + +HasNamespace returns a boolean if a field has been set. + +### GetWeight + +`func (o *PerformanceAdvisorIndex) GetWeight() float64` + +GetWeight returns the Weight field if non-nil, zero value otherwise. + +### GetWeightOk + +`func (o *PerformanceAdvisorIndex) GetWeightOk() (*float64, bool)` + +GetWeightOk returns a tuple with the Weight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWeight + +`func (o *PerformanceAdvisorIndex) SetWeight(v float64)` + +SetWeight sets Weight field to given value. + +### HasWeight + +`func (o *PerformanceAdvisorIndex) HasWeight() bool` + +HasWeight returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PerformanceAdvisorOpStats.md b/docs/docs/PerformanceAdvisorOpStats.md new file mode 100644 index 00000000..fed9e61d --- /dev/null +++ b/docs/docs/PerformanceAdvisorOpStats.md @@ -0,0 +1,134 @@ +# PerformanceAdvisorOpStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ms** | Pointer to **int64** | Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter. | [optional] [readonly] +**NReturned** | Pointer to **int64** | Number of results that the query returns. | [optional] [readonly] +**NScanned** | Pointer to **int64** | Number of documents that the query read. | [optional] [readonly] +**Ts** | Pointer to **int64** | Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter. | [optional] [readonly] + +## Methods + +### NewPerformanceAdvisorOpStats + +`func NewPerformanceAdvisorOpStats() *PerformanceAdvisorOpStats` + +NewPerformanceAdvisorOpStats instantiates a new PerformanceAdvisorOpStats object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPerformanceAdvisorOpStatsWithDefaults + +`func NewPerformanceAdvisorOpStatsWithDefaults() *PerformanceAdvisorOpStats` + +NewPerformanceAdvisorOpStatsWithDefaults instantiates a new PerformanceAdvisorOpStats object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMs + +`func (o *PerformanceAdvisorOpStats) GetMs() int64` + +GetMs returns the Ms field if non-nil, zero value otherwise. + +### GetMsOk + +`func (o *PerformanceAdvisorOpStats) GetMsOk() (*int64, bool)` + +GetMsOk returns a tuple with the Ms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMs + +`func (o *PerformanceAdvisorOpStats) SetMs(v int64)` + +SetMs sets Ms field to given value. + +### HasMs + +`func (o *PerformanceAdvisorOpStats) HasMs() bool` + +HasMs returns a boolean if a field has been set. + +### GetNReturned + +`func (o *PerformanceAdvisorOpStats) GetNReturned() int64` + +GetNReturned returns the NReturned field if non-nil, zero value otherwise. + +### GetNReturnedOk + +`func (o *PerformanceAdvisorOpStats) GetNReturnedOk() (*int64, bool)` + +GetNReturnedOk returns a tuple with the NReturned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNReturned + +`func (o *PerformanceAdvisorOpStats) SetNReturned(v int64)` + +SetNReturned sets NReturned field to given value. + +### HasNReturned + +`func (o *PerformanceAdvisorOpStats) HasNReturned() bool` + +HasNReturned returns a boolean if a field has been set. + +### GetNScanned + +`func (o *PerformanceAdvisorOpStats) GetNScanned() int64` + +GetNScanned returns the NScanned field if non-nil, zero value otherwise. + +### GetNScannedOk + +`func (o *PerformanceAdvisorOpStats) GetNScannedOk() (*int64, bool)` + +GetNScannedOk returns a tuple with the NScanned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNScanned + +`func (o *PerformanceAdvisorOpStats) SetNScanned(v int64)` + +SetNScanned sets NScanned field to given value. + +### HasNScanned + +`func (o *PerformanceAdvisorOpStats) HasNScanned() bool` + +HasNScanned returns a boolean if a field has been set. + +### GetTs + +`func (o *PerformanceAdvisorOpStats) GetTs() int64` + +GetTs returns the Ts field if non-nil, zero value otherwise. + +### GetTsOk + +`func (o *PerformanceAdvisorOpStats) GetTsOk() (*int64, bool)` + +GetTsOk returns a tuple with the Ts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTs + +`func (o *PerformanceAdvisorOpStats) SetTs(v int64)` + +SetTs sets Ts field to given value. + +### HasTs + +`func (o *PerformanceAdvisorOpStats) HasTs() bool` + +HasTs returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PerformanceAdvisorOperation.md b/docs/docs/PerformanceAdvisorOperation.md new file mode 100644 index 00000000..03941e22 --- /dev/null +++ b/docs/docs/PerformanceAdvisorOperation.md @@ -0,0 +1,82 @@ +# PerformanceAdvisorOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Predicates** | Pointer to **[]map[string]interface{}** | List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values. | [optional] [readonly] +**Stats** | Pointer to [**PerformanceAdvisorOpStats**](PerformanceAdvisorOpStats.md) | | [optional] + +## Methods + +### NewPerformanceAdvisorOperation + +`func NewPerformanceAdvisorOperation() *PerformanceAdvisorOperation` + +NewPerformanceAdvisorOperation instantiates a new PerformanceAdvisorOperation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPerformanceAdvisorOperationWithDefaults + +`func NewPerformanceAdvisorOperationWithDefaults() *PerformanceAdvisorOperation` + +NewPerformanceAdvisorOperationWithDefaults instantiates a new PerformanceAdvisorOperation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPredicates + +`func (o *PerformanceAdvisorOperation) GetPredicates() []map[string]interface{}` + +GetPredicates returns the Predicates field if non-nil, zero value otherwise. + +### GetPredicatesOk + +`func (o *PerformanceAdvisorOperation) GetPredicatesOk() (*[]map[string]interface{}, bool)` + +GetPredicatesOk returns a tuple with the Predicates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPredicates + +`func (o *PerformanceAdvisorOperation) SetPredicates(v []map[string]interface{})` + +SetPredicates sets Predicates field to given value. + +### HasPredicates + +`func (o *PerformanceAdvisorOperation) HasPredicates() bool` + +HasPredicates returns a boolean if a field has been set. + +### GetStats + +`func (o *PerformanceAdvisorOperation) GetStats() PerformanceAdvisorOpStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *PerformanceAdvisorOperation) GetStatsOk() (*PerformanceAdvisorOpStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *PerformanceAdvisorOperation) SetStats(v PerformanceAdvisorOpStats)` + +SetStats sets Stats field to given value. + +### HasStats + +`func (o *PerformanceAdvisorOperation) HasStats() bool` + +HasStats returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PerformanceAdvisorResponse.md b/docs/docs/PerformanceAdvisorResponse.md new file mode 100644 index 00000000..5b3d10ae --- /dev/null +++ b/docs/docs/PerformanceAdvisorResponse.md @@ -0,0 +1,82 @@ +# PerformanceAdvisorResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Shapes** | Pointer to [**[]PerformanceAdvisorShape**](PerformanceAdvisorShape.md) | List of query predicates, sorts, and projections that the Performance Advisor suggests. | [optional] [readonly] +**SuggestedIndexes** | Pointer to [**[]PerformanceAdvisorIndex**](PerformanceAdvisorIndex.md) | List that contains the documents with information about the indexes that the Performance Advisor suggests. | [optional] [readonly] + +## Methods + +### NewPerformanceAdvisorResponse + +`func NewPerformanceAdvisorResponse() *PerformanceAdvisorResponse` + +NewPerformanceAdvisorResponse instantiates a new PerformanceAdvisorResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPerformanceAdvisorResponseWithDefaults + +`func NewPerformanceAdvisorResponseWithDefaults() *PerformanceAdvisorResponse` + +NewPerformanceAdvisorResponseWithDefaults instantiates a new PerformanceAdvisorResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetShapes + +`func (o *PerformanceAdvisorResponse) GetShapes() []PerformanceAdvisorShape` + +GetShapes returns the Shapes field if non-nil, zero value otherwise. + +### GetShapesOk + +`func (o *PerformanceAdvisorResponse) GetShapesOk() (*[]PerformanceAdvisorShape, bool)` + +GetShapesOk returns a tuple with the Shapes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShapes + +`func (o *PerformanceAdvisorResponse) SetShapes(v []PerformanceAdvisorShape)` + +SetShapes sets Shapes field to given value. + +### HasShapes + +`func (o *PerformanceAdvisorResponse) HasShapes() bool` + +HasShapes returns a boolean if a field has been set. + +### GetSuggestedIndexes + +`func (o *PerformanceAdvisorResponse) GetSuggestedIndexes() []PerformanceAdvisorIndex` + +GetSuggestedIndexes returns the SuggestedIndexes field if non-nil, zero value otherwise. + +### GetSuggestedIndexesOk + +`func (o *PerformanceAdvisorResponse) GetSuggestedIndexesOk() (*[]PerformanceAdvisorIndex, bool)` + +GetSuggestedIndexesOk returns a tuple with the SuggestedIndexes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuggestedIndexes + +`func (o *PerformanceAdvisorResponse) SetSuggestedIndexes(v []PerformanceAdvisorIndex)` + +SetSuggestedIndexes sets SuggestedIndexes field to given value. + +### HasSuggestedIndexes + +`func (o *PerformanceAdvisorResponse) HasSuggestedIndexes() bool` + +HasSuggestedIndexes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PerformanceAdvisorShape.md b/docs/docs/PerformanceAdvisorShape.md new file mode 100644 index 00000000..aec39b04 --- /dev/null +++ b/docs/docs/PerformanceAdvisorShape.md @@ -0,0 +1,186 @@ +# PerformanceAdvisorShape + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AvgMs** | Pointer to **int64** | Average duration in milliseconds for the queries examined that match this shape. | [optional] [readonly] +**Count** | Pointer to **int64** | Number of queries examined that match this shape. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request. | [optional] [readonly] +**InefficiencyScore** | Pointer to **int64** | Average number of documents read for every document that the query returns. | [optional] [readonly] +**Namespace** | Pointer to **string** | Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `<database>.<collection>`. | [optional] [readonly] +**Operations** | Pointer to [**[]PerformanceAdvisorOperation**](PerformanceAdvisorOperation.md) | List that contains specific about individual queries. | [optional] [readonly] + +## Methods + +### NewPerformanceAdvisorShape + +`func NewPerformanceAdvisorShape() *PerformanceAdvisorShape` + +NewPerformanceAdvisorShape instantiates a new PerformanceAdvisorShape object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPerformanceAdvisorShapeWithDefaults + +`func NewPerformanceAdvisorShapeWithDefaults() *PerformanceAdvisorShape` + +NewPerformanceAdvisorShapeWithDefaults instantiates a new PerformanceAdvisorShape object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAvgMs + +`func (o *PerformanceAdvisorShape) GetAvgMs() int64` + +GetAvgMs returns the AvgMs field if non-nil, zero value otherwise. + +### GetAvgMsOk + +`func (o *PerformanceAdvisorShape) GetAvgMsOk() (*int64, bool)` + +GetAvgMsOk returns a tuple with the AvgMs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvgMs + +`func (o *PerformanceAdvisorShape) SetAvgMs(v int64)` + +SetAvgMs sets AvgMs field to given value. + +### HasAvgMs + +`func (o *PerformanceAdvisorShape) HasAvgMs() bool` + +HasAvgMs returns a boolean if a field has been set. + +### GetCount + +`func (o *PerformanceAdvisorShape) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *PerformanceAdvisorShape) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *PerformanceAdvisorShape) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *PerformanceAdvisorShape) HasCount() bool` + +HasCount returns a boolean if a field has been set. + +### GetId + +`func (o *PerformanceAdvisorShape) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PerformanceAdvisorShape) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PerformanceAdvisorShape) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PerformanceAdvisorShape) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetInefficiencyScore + +`func (o *PerformanceAdvisorShape) GetInefficiencyScore() int64` + +GetInefficiencyScore returns the InefficiencyScore field if non-nil, zero value otherwise. + +### GetInefficiencyScoreOk + +`func (o *PerformanceAdvisorShape) GetInefficiencyScoreOk() (*int64, bool)` + +GetInefficiencyScoreOk returns a tuple with the InefficiencyScore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInefficiencyScore + +`func (o *PerformanceAdvisorShape) SetInefficiencyScore(v int64)` + +SetInefficiencyScore sets InefficiencyScore field to given value. + +### HasInefficiencyScore + +`func (o *PerformanceAdvisorShape) HasInefficiencyScore() bool` + +HasInefficiencyScore returns a boolean if a field has been set. + +### GetNamespace + +`func (o *PerformanceAdvisorShape) GetNamespace() string` + +GetNamespace returns the Namespace field if non-nil, zero value otherwise. + +### GetNamespaceOk + +`func (o *PerformanceAdvisorShape) GetNamespaceOk() (*string, bool)` + +GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNamespace + +`func (o *PerformanceAdvisorShape) SetNamespace(v string)` + +SetNamespace sets Namespace field to given value. + +### HasNamespace + +`func (o *PerformanceAdvisorShape) HasNamespace() bool` + +HasNamespace returns a boolean if a field has been set. + +### GetOperations + +`func (o *PerformanceAdvisorShape) GetOperations() []PerformanceAdvisorOperation` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *PerformanceAdvisorShape) GetOperationsOk() (*[]PerformanceAdvisorOperation, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperations + +`func (o *PerformanceAdvisorShape) SetOperations(v []PerformanceAdvisorOperation)` + +SetOperations sets Operations field to given value. + +### HasOperations + +`func (o *PerformanceAdvisorShape) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PerformanceAdvisorSlowQuery.md b/docs/docs/PerformanceAdvisorSlowQuery.md new file mode 100644 index 00000000..8e9b9ed9 --- /dev/null +++ b/docs/docs/PerformanceAdvisorSlowQuery.md @@ -0,0 +1,82 @@ +# PerformanceAdvisorSlowQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Line** | Pointer to **string** | Text of the MongoDB log related to this slow query. | [optional] [readonly] +**Namespace** | Pointer to **string** | Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `<database>.<collection>`. | [optional] [readonly] + +## Methods + +### NewPerformanceAdvisorSlowQuery + +`func NewPerformanceAdvisorSlowQuery() *PerformanceAdvisorSlowQuery` + +NewPerformanceAdvisorSlowQuery instantiates a new PerformanceAdvisorSlowQuery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPerformanceAdvisorSlowQueryWithDefaults + +`func NewPerformanceAdvisorSlowQueryWithDefaults() *PerformanceAdvisorSlowQuery` + +NewPerformanceAdvisorSlowQueryWithDefaults instantiates a new PerformanceAdvisorSlowQuery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLine + +`func (o *PerformanceAdvisorSlowQuery) GetLine() string` + +GetLine returns the Line field if non-nil, zero value otherwise. + +### GetLineOk + +`func (o *PerformanceAdvisorSlowQuery) GetLineOk() (*string, bool)` + +GetLineOk returns a tuple with the Line field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLine + +`func (o *PerformanceAdvisorSlowQuery) SetLine(v string)` + +SetLine sets Line field to given value. + +### HasLine + +`func (o *PerformanceAdvisorSlowQuery) HasLine() bool` + +HasLine returns a boolean if a field has been set. + +### GetNamespace + +`func (o *PerformanceAdvisorSlowQuery) GetNamespace() string` + +GetNamespace returns the Namespace field if non-nil, zero value otherwise. + +### GetNamespaceOk + +`func (o *PerformanceAdvisorSlowQuery) GetNamespaceOk() (*string, bool)` + +GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNamespace + +`func (o *PerformanceAdvisorSlowQuery) SetNamespace(v string)` + +SetNamespace sets Namespace field to given value. + +### HasNamespace + +`func (o *PerformanceAdvisorSlowQuery) HasNamespace() bool` + +HasNamespace returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PerformanceAdvisorSlowQueryList.md b/docs/docs/PerformanceAdvisorSlowQueryList.md new file mode 100644 index 00000000..30a84320 --- /dev/null +++ b/docs/docs/PerformanceAdvisorSlowQueryList.md @@ -0,0 +1,56 @@ +# PerformanceAdvisorSlowQueryList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SlowQueries** | Pointer to [**[]PerformanceAdvisorSlowQuery**](PerformanceAdvisorSlowQuery.md) | List of operations that the Performance Advisor detected that took longer to execute than a specified threshold. | [optional] [readonly] + +## Methods + +### NewPerformanceAdvisorSlowQueryList + +`func NewPerformanceAdvisorSlowQueryList() *PerformanceAdvisorSlowQueryList` + +NewPerformanceAdvisorSlowQueryList instantiates a new PerformanceAdvisorSlowQueryList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPerformanceAdvisorSlowQueryListWithDefaults + +`func NewPerformanceAdvisorSlowQueryListWithDefaults() *PerformanceAdvisorSlowQueryList` + +NewPerformanceAdvisorSlowQueryListWithDefaults instantiates a new PerformanceAdvisorSlowQueryList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetSlowQueries + +`func (o *PerformanceAdvisorSlowQueryList) GetSlowQueries() []PerformanceAdvisorSlowQuery` + +GetSlowQueries returns the SlowQueries field if non-nil, zero value otherwise. + +### GetSlowQueriesOk + +`func (o *PerformanceAdvisorSlowQueryList) GetSlowQueriesOk() (*[]PerformanceAdvisorSlowQuery, bool)` + +GetSlowQueriesOk returns a tuple with the SlowQueries field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSlowQueries + +`func (o *PerformanceAdvisorSlowQueryList) SetSlowQueries(v []PerformanceAdvisorSlowQuery)` + +SetSlowQueries sets SlowQueries field to given value. + +### HasSlowQueries + +`func (o *PerformanceAdvisorSlowQueryList) HasSlowQueries() bool` + +HasSlowQueries returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PeriodicCpsSnapshotSource.md b/docs/docs/PeriodicCpsSnapshotSource.md new file mode 100644 index 00000000..22778ac8 --- /dev/null +++ b/docs/docs/PeriodicCpsSnapshotSource.md @@ -0,0 +1,186 @@ +# PeriodicCpsSnapshotSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | Pointer to **string** | Human-readable name that identifies the cluster. | [optional] +**CollectionName** | Pointer to **string** | Human-readable name that identifies the collection. | [optional] +**DatabaseName** | Pointer to **string** | Human-readable name that identifies the database. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**PolicyItemId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies a policy item. | [optional] +**Type** | Pointer to **string** | Type of ingestion source of this Data Lake Pipeline. | [optional] + +## Methods + +### NewPeriodicCpsSnapshotSource + +`func NewPeriodicCpsSnapshotSource() *PeriodicCpsSnapshotSource` + +NewPeriodicCpsSnapshotSource instantiates a new PeriodicCpsSnapshotSource object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPeriodicCpsSnapshotSourceWithDefaults + +`func NewPeriodicCpsSnapshotSourceWithDefaults() *PeriodicCpsSnapshotSource` + +NewPeriodicCpsSnapshotSourceWithDefaults instantiates a new PeriodicCpsSnapshotSource object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *PeriodicCpsSnapshotSource) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *PeriodicCpsSnapshotSource) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *PeriodicCpsSnapshotSource) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *PeriodicCpsSnapshotSource) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCollectionName + +`func (o *PeriodicCpsSnapshotSource) GetCollectionName() string` + +GetCollectionName returns the CollectionName field if non-nil, zero value otherwise. + +### GetCollectionNameOk + +`func (o *PeriodicCpsSnapshotSource) GetCollectionNameOk() (*string, bool)` + +GetCollectionNameOk returns a tuple with the CollectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionName + +`func (o *PeriodicCpsSnapshotSource) SetCollectionName(v string)` + +SetCollectionName sets CollectionName field to given value. + +### HasCollectionName + +`func (o *PeriodicCpsSnapshotSource) HasCollectionName() bool` + +HasCollectionName returns a boolean if a field has been set. + +### GetDatabaseName + +`func (o *PeriodicCpsSnapshotSource) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *PeriodicCpsSnapshotSource) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *PeriodicCpsSnapshotSource) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + +### HasDatabaseName + +`func (o *PeriodicCpsSnapshotSource) HasDatabaseName() bool` + +HasDatabaseName returns a boolean if a field has been set. + +### GetGroupId + +`func (o *PeriodicCpsSnapshotSource) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *PeriodicCpsSnapshotSource) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *PeriodicCpsSnapshotSource) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *PeriodicCpsSnapshotSource) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetPolicyItemId + +`func (o *PeriodicCpsSnapshotSource) GetPolicyItemId() string` + +GetPolicyItemId returns the PolicyItemId field if non-nil, zero value otherwise. + +### GetPolicyItemIdOk + +`func (o *PeriodicCpsSnapshotSource) GetPolicyItemIdOk() (*string, bool)` + +GetPolicyItemIdOk returns a tuple with the PolicyItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyItemId + +`func (o *PeriodicCpsSnapshotSource) SetPolicyItemId(v string)` + +SetPolicyItemId sets PolicyItemId field to given value. + +### HasPolicyItemId + +`func (o *PeriodicCpsSnapshotSource) HasPolicyItemId() bool` + +HasPolicyItemId returns a boolean if a field has been set. + +### GetType + +`func (o *PeriodicCpsSnapshotSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PeriodicCpsSnapshotSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PeriodicCpsSnapshotSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PeriodicCpsSnapshotSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PipelineRunStats.md b/docs/docs/PipelineRunStats.md new file mode 100644 index 00000000..f6b6ad3e --- /dev/null +++ b/docs/docs/PipelineRunStats.md @@ -0,0 +1,82 @@ +# PipelineRunStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BytesExported** | Pointer to **int64** | Total data size in bytes exported for this pipeline run. | [optional] [readonly] +**NumDocs** | Pointer to **int64** | Number of docs ingested for a this pipeline run. | [optional] [readonly] + +## Methods + +### NewPipelineRunStats + +`func NewPipelineRunStats() *PipelineRunStats` + +NewPipelineRunStats instantiates a new PipelineRunStats object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPipelineRunStatsWithDefaults + +`func NewPipelineRunStatsWithDefaults() *PipelineRunStats` + +NewPipelineRunStatsWithDefaults instantiates a new PipelineRunStats object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBytesExported + +`func (o *PipelineRunStats) GetBytesExported() int64` + +GetBytesExported returns the BytesExported field if non-nil, zero value otherwise. + +### GetBytesExportedOk + +`func (o *PipelineRunStats) GetBytesExportedOk() (*int64, bool)` + +GetBytesExportedOk returns a tuple with the BytesExported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBytesExported + +`func (o *PipelineRunStats) SetBytesExported(v int64)` + +SetBytesExported sets BytesExported field to given value. + +### HasBytesExported + +`func (o *PipelineRunStats) HasBytesExported() bool` + +HasBytesExported returns a boolean if a field has been set. + +### GetNumDocs + +`func (o *PipelineRunStats) GetNumDocs() int64` + +GetNumDocs returns the NumDocs field if non-nil, zero value otherwise. + +### GetNumDocsOk + +`func (o *PipelineRunStats) GetNumDocsOk() (*int64, bool)` + +GetNumDocsOk returns a tuple with the NumDocs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumDocs + +`func (o *PipelineRunStats) SetNumDocs(v int64)` + +SetNumDocs sets NumDocs field to given value. + +### HasNumDocs + +`func (o *PipelineRunStats) HasNumDocs() bool` + +HasNumDocs returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Policy.md b/docs/docs/Policy.md new file mode 100644 index 00000000..f31ef4a0 --- /dev/null +++ b/docs/docs/Policy.md @@ -0,0 +1,82 @@ +# Policy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this backup policy. | [optional] +**PolicyItems** | Pointer to [**[]PolicyItem**](PolicyItem.md) | List that contains the specifications for one policy. | [optional] + +## Methods + +### NewPolicy + +`func NewPolicy() *Policy` + +NewPolicy instantiates a new Policy object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPolicyWithDefaults + +`func NewPolicyWithDefaults() *Policy` + +NewPolicyWithDefaults instantiates a new Policy object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *Policy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Policy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Policy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Policy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetPolicyItems + +`func (o *Policy) GetPolicyItems() []PolicyItem` + +GetPolicyItems returns the PolicyItems field if non-nil, zero value otherwise. + +### GetPolicyItemsOk + +`func (o *Policy) GetPolicyItemsOk() (*[]PolicyItem, bool)` + +GetPolicyItemsOk returns a tuple with the PolicyItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyItems + +`func (o *Policy) SetPolicyItems(v []PolicyItem)` + +SetPolicyItems sets PolicyItems field to given value. + +### HasPolicyItems + +`func (o *Policy) HasPolicyItems() bool` + +HasPolicyItems returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PolicyItem.md b/docs/docs/PolicyItem.md new file mode 100644 index 00000000..06c93e0e --- /dev/null +++ b/docs/docs/PolicyItem.md @@ -0,0 +1,140 @@ +# PolicyItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FrequencyInterval** | **int** | Number that indicates the frequency interval for a set of snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`. - In a monthly policy item, `1` indicates that the monthly snapshot occurs on the first day of the month and `40` indicates the last day of the month. - In a weekly policy item, `1` indicates that the weekly snapshot occurs on Monday and `7` indicates Sunday. - In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings. | +**FrequencyType** | **string** | Human-readable label that identifies the frequency type associated with the backup policy. | +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this backup policy item. | [optional] [readonly] +**RetentionUnit** | **string** | Unit of time in which MongoDB Cloud measures snapshot retention. | +**RetentionValue** | **int** | Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item. | + +## Methods + +### NewPolicyItem + +`func NewPolicyItem(frequencyInterval int, frequencyType string, retentionUnit string, retentionValue int, ) *PolicyItem` + +NewPolicyItem instantiates a new PolicyItem object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPolicyItemWithDefaults + +`func NewPolicyItemWithDefaults() *PolicyItem` + +NewPolicyItemWithDefaults instantiates a new PolicyItem object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFrequencyInterval + +`func (o *PolicyItem) GetFrequencyInterval() int` + +GetFrequencyInterval returns the FrequencyInterval field if non-nil, zero value otherwise. + +### GetFrequencyIntervalOk + +`func (o *PolicyItem) GetFrequencyIntervalOk() (*int, bool)` + +GetFrequencyIntervalOk returns a tuple with the FrequencyInterval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencyInterval + +`func (o *PolicyItem) SetFrequencyInterval(v int)` + +SetFrequencyInterval sets FrequencyInterval field to given value. + + +### GetFrequencyType + +`func (o *PolicyItem) GetFrequencyType() string` + +GetFrequencyType returns the FrequencyType field if non-nil, zero value otherwise. + +### GetFrequencyTypeOk + +`func (o *PolicyItem) GetFrequencyTypeOk() (*string, bool)` + +GetFrequencyTypeOk returns a tuple with the FrequencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencyType + +`func (o *PolicyItem) SetFrequencyType(v string)` + +SetFrequencyType sets FrequencyType field to given value. + + +### GetId + +`func (o *PolicyItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PolicyItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PolicyItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PolicyItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRetentionUnit + +`func (o *PolicyItem) GetRetentionUnit() string` + +GetRetentionUnit returns the RetentionUnit field if non-nil, zero value otherwise. + +### GetRetentionUnitOk + +`func (o *PolicyItem) GetRetentionUnitOk() (*string, bool)` + +GetRetentionUnitOk returns a tuple with the RetentionUnit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetentionUnit + +`func (o *PolicyItem) SetRetentionUnit(v string)` + +SetRetentionUnit sets RetentionUnit field to given value. + + +### GetRetentionValue + +`func (o *PolicyItem) GetRetentionValue() int` + +GetRetentionValue returns the RetentionValue field if non-nil, zero value otherwise. + +### GetRetentionValueOk + +`func (o *PolicyItem) GetRetentionValueOk() (*int, bool)` + +GetRetentionValueOk returns a tuple with the RetentionValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetentionValue + +`func (o *PolicyItem) SetRetentionValue(v int)` + +SetRetentionValue sets RetentionValue field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PrivateEndpointServicesApi.md b/docs/docs/PrivateEndpointServicesApi.md new file mode 100644 index 00000000..8b196f04 --- /dev/null +++ b/docs/docs/PrivateEndpointServicesApi.md @@ -0,0 +1,724 @@ +# \PrivateEndpointServicesApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreatePrivateEndpoint**](PrivateEndpointServicesApi.md#CreatePrivateEndpoint) | **Post** /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint | Create One Private Endpoint for One Provider +[**CreatePrivateEndpointService**](PrivateEndpointServicesApi.md#CreatePrivateEndpointService) | **Post** /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService | Create One Private Endpoint Service for One Provider +[**DeletePrivateEndpoint**](PrivateEndpointServicesApi.md#DeletePrivateEndpoint) | **Delete** /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId} | Remove One Private Endpoint for One Provider +[**DeletePrivateEndpointService**](PrivateEndpointServicesApi.md#DeletePrivateEndpointService) | **Delete** /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId} | Remove One Private Endpoint Service for One Provider +[**GetPrivateEndpoint**](PrivateEndpointServicesApi.md#GetPrivateEndpoint) | **Get** /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId} | Return One Private Endpoint for One Provider +[**GetPrivateEndpointService**](PrivateEndpointServicesApi.md#GetPrivateEndpointService) | **Get** /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId} | Return One Private Endpoint Service for One Provider +[**GetRegionalizedPrivateEndpointSetting**](PrivateEndpointServicesApi.md#GetRegionalizedPrivateEndpointSetting) | **Get** /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode | Return Regionalized Private Endpoint Status +[**ListPrivateEndpointServices**](PrivateEndpointServicesApi.md#ListPrivateEndpointServices) | **Get** /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService | Return All Private Endpoint Services for One Provider +[**ToggleRegionalizedPrivateEndpointSetting**](PrivateEndpointServicesApi.md#ToggleRegionalizedPrivateEndpointSetting) | **Patch** /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode | Toggle Regionalized Private Endpoint Status + + + +## CreatePrivateEndpoint + +> Endpoint CreatePrivateEndpoint(ctx, groupId, cloudProvider, endpointServiceId).CreatePrivateEndpointRequest(createPrivateEndpointRequest).Execute() + +Create One Private Endpoint for One Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProvider := "cloudProvider_example" // string | (default to "AWS") + endpointServiceId := "endpointServiceId_example" // string | + createPrivateEndpointRequest := openapiclient.createPrivateEndpoint_request{CreateAWSEndpointRequest: openapiclient.NewCreateAWSEndpointRequest()} // CreatePrivateEndpointRequest | + + resp, r, err := sdk.PrivateEndpointServicesApi.CreatePrivateEndpoint(context.Background(), groupId, cloudProvider, endpointServiceId).CreatePrivateEndpointRequest(createPrivateEndpointRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.CreatePrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreatePrivateEndpoint`: Endpoint + fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointServicesApi.CreatePrivateEndpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**cloudProvider** | **string** | Cloud service provider that manages this private endpoint. | [default to "AWS"] +**endpointServiceId** | **string** | Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **createPrivateEndpointRequest** | [**CreatePrivateEndpointRequest**](CreatePrivateEndpointRequest.md) | Creates one private endpoint for the specified cloud service provider. | + +### Return type + +[**Endpoint**](Endpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreatePrivateEndpointService + +> EndpointService CreatePrivateEndpointService(ctx, groupId).CreateEndpointServiceRequest(createEndpointServiceRequest).Execute() + +Create One Private Endpoint Service for One Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + createEndpointServiceRequest := *openapiclient.NewCreateEndpointServiceRequest("ProviderName_example", "Region_example") // CreateEndpointServiceRequest | + + resp, r, err := sdk.PrivateEndpointServicesApi.CreatePrivateEndpointService(context.Background(), groupId).CreateEndpointServiceRequest(createEndpointServiceRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.CreatePrivateEndpointService``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreatePrivateEndpointService`: EndpointService + fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointServicesApi.CreatePrivateEndpointService`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePrivateEndpointServiceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createEndpointServiceRequest** | [**CreateEndpointServiceRequest**](CreateEndpointServiceRequest.md) | Creates one private endpoint for the specified cloud service provider. | + +### Return type + +[**EndpointService**](EndpointService.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePrivateEndpoint + +> DeletePrivateEndpoint(ctx, groupId, cloudProvider, endpointId, endpointServiceId).Execute() + +Remove One Private Endpoint for One Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProvider := "cloudProvider_example" // string | (default to "AWS") + endpointId := "endpointId_example" // string | + endpointServiceId := "endpointServiceId_example" // string | + + r, err := sdk.PrivateEndpointServicesApi.DeletePrivateEndpoint(context.Background(), groupId, cloudProvider, endpointId, endpointServiceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.DeletePrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**cloudProvider** | **string** | Cloud service provider that manages this private endpoint. | [default to "AWS"] +**endpointId** | **string** | Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. | +**endpointServiceId** | **string** | Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePrivateEndpointService + +> DeletePrivateEndpointService(ctx, groupId, cloudProvider, endpointServiceId).Execute() + +Remove One Private Endpoint Service for One Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProvider := "cloudProvider_example" // string | (default to "AWS") + endpointServiceId := "endpointServiceId_example" // string | + + r, err := sdk.PrivateEndpointServicesApi.DeletePrivateEndpointService(context.Background(), groupId, cloudProvider, endpointServiceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.DeletePrivateEndpointService``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**cloudProvider** | **string** | Cloud service provider that manages this private endpoint service. | [default to "AWS"] +**endpointServiceId** | **string** | Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePrivateEndpointServiceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPrivateEndpoint + +> Endpoint GetPrivateEndpoint(ctx, groupId, cloudProvider, endpointId, endpointServiceId).Execute() + +Return One Private Endpoint for One Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProvider := "cloudProvider_example" // string | (default to "AWS") + endpointId := "endpointId_example" // string | + endpointServiceId := "endpointServiceId_example" // string | + + resp, r, err := sdk.PrivateEndpointServicesApi.GetPrivateEndpoint(context.Background(), groupId, cloudProvider, endpointId, endpointServiceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.GetPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetPrivateEndpoint`: Endpoint + fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointServicesApi.GetPrivateEndpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**cloudProvider** | **string** | Cloud service provider that manages this private endpoint. | [default to "AWS"] +**endpointId** | **string** | Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints. | +**endpointServiceId** | **string** | Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + + +### Return type + +[**Endpoint**](Endpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPrivateEndpointService + +> EndpointService GetPrivateEndpointService(ctx, groupId, cloudProvider, endpointServiceId).Execute() + +Return One Private Endpoint Service for One Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProvider := "cloudProvider_example" // string | (default to "AWS") + endpointServiceId := "endpointServiceId_example" // string | + + resp, r, err := sdk.PrivateEndpointServicesApi.GetPrivateEndpointService(context.Background(), groupId, cloudProvider, endpointServiceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.GetPrivateEndpointService``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetPrivateEndpointService`: EndpointService + fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointServicesApi.GetPrivateEndpointService`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**cloudProvider** | **string** | Cloud service provider that manages this private endpoint service. | [default to "AWS"] +**endpointServiceId** | **string** | Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPrivateEndpointServiceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**EndpointService**](EndpointService.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetRegionalizedPrivateEndpointSetting + +> ProjectSettingItem GetRegionalizedPrivateEndpointSetting(ctx, groupId).Execute() + +Return Regionalized Private Endpoint Status + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.PrivateEndpointServicesApi.GetRegionalizedPrivateEndpointSetting(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.GetRegionalizedPrivateEndpointSetting``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetRegionalizedPrivateEndpointSetting`: ProjectSettingItem + fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointServicesApi.GetRegionalizedPrivateEndpointSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRegionalizedPrivateEndpointSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ProjectSettingItem**](ProjectSettingItem.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListPrivateEndpointServices + +> PaginatedPrivateLinkConnection ListPrivateEndpointServices(ctx, groupId, cloudProvider).Execute() + +Return All Private Endpoint Services for One Provider + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + cloudProvider := "cloudProvider_example" // string | (default to "AWS") + + resp, r, err := sdk.PrivateEndpointServicesApi.ListPrivateEndpointServices(context.Background(), groupId, cloudProvider).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.ListPrivateEndpointServices``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListPrivateEndpointServices`: PaginatedPrivateLinkConnection + fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointServicesApi.ListPrivateEndpointServices`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**cloudProvider** | **string** | Cloud service provider that manages this private endpoint service. | [default to "AWS"] + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPrivateEndpointServicesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**PaginatedPrivateLinkConnection**](PaginatedPrivateLinkConnection.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ToggleRegionalizedPrivateEndpointSetting + +> ProjectSettingItem ToggleRegionalizedPrivateEndpointSetting(ctx, groupId).ProjectSettingItem(projectSettingItem).Execute() + +Toggle Regionalized Private Endpoint Status + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + projectSettingItem := *openapiclient.NewProjectSettingItem(false) // ProjectSettingItem | + + resp, r, err := sdk.PrivateEndpointServicesApi.ToggleRegionalizedPrivateEndpointSetting(context.Background(), groupId).ProjectSettingItem(projectSettingItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PrivateEndpointServicesApi.ToggleRegionalizedPrivateEndpointSetting``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ToggleRegionalizedPrivateEndpointSetting`: ProjectSettingItem + fmt.Fprintf(os.Stdout, "Response from `PrivateEndpointServicesApi.ToggleRegionalizedPrivateEndpointSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiToggleRegionalizedPrivateEndpointSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **projectSettingItem** | [**ProjectSettingItem**](ProjectSettingItem.md) | Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. | + +### Return type + +[**ProjectSettingItem**](ProjectSettingItem.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/PrivateIPMode.md b/docs/docs/PrivateIPMode.md new file mode 100644 index 00000000..8930bfec --- /dev/null +++ b/docs/docs/PrivateIPMode.md @@ -0,0 +1,51 @@ +# PrivateIPMode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **bool** | Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project. | + +## Methods + +### NewPrivateIPMode + +`func NewPrivateIPMode(enabled bool, ) *PrivateIPMode` + +NewPrivateIPMode instantiates a new PrivateIPMode object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPrivateIPModeWithDefaults + +`func NewPrivateIPModeWithDefaults() *PrivateIPMode` + +NewPrivateIPModeWithDefaults instantiates a new PrivateIPMode object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *PrivateIPMode) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *PrivateIPMode) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *PrivateIPMode) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/PrivateNetworkEndpointIdEntry.md b/docs/docs/PrivateNetworkEndpointIdEntry.md new file mode 100644 index 00000000..828ccbac --- /dev/null +++ b/docs/docs/PrivateNetworkEndpointIdEntry.md @@ -0,0 +1,129 @@ +# PrivateNetworkEndpointIdEntry + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Human-readable string to associate with this private endpoint. | [optional] +**EndpointId** | **string** | Unique 22-character alphanumeric string that identifies the private endpoint. | +**Provider** | Pointer to **string** | Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only. | [optional] [default to "AWS"] +**Type** | Pointer to **string** | Human-readable label that identifies the resource type associated with this private endpoint. | [optional] [default to "DATA_LAKE"] + +## Methods + +### NewPrivateNetworkEndpointIdEntry + +`func NewPrivateNetworkEndpointIdEntry(endpointId string, ) *PrivateNetworkEndpointIdEntry` + +NewPrivateNetworkEndpointIdEntry instantiates a new PrivateNetworkEndpointIdEntry object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPrivateNetworkEndpointIdEntryWithDefaults + +`func NewPrivateNetworkEndpointIdEntryWithDefaults() *PrivateNetworkEndpointIdEntry` + +NewPrivateNetworkEndpointIdEntryWithDefaults instantiates a new PrivateNetworkEndpointIdEntry object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetComment + +`func (o *PrivateNetworkEndpointIdEntry) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *PrivateNetworkEndpointIdEntry) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *PrivateNetworkEndpointIdEntry) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *PrivateNetworkEndpointIdEntry) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetEndpointId + +`func (o *PrivateNetworkEndpointIdEntry) GetEndpointId() string` + +GetEndpointId returns the EndpointId field if non-nil, zero value otherwise. + +### GetEndpointIdOk + +`func (o *PrivateNetworkEndpointIdEntry) GetEndpointIdOk() (*string, bool)` + +GetEndpointIdOk returns a tuple with the EndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointId + +`func (o *PrivateNetworkEndpointIdEntry) SetEndpointId(v string)` + +SetEndpointId sets EndpointId field to given value. + + +### GetProvider + +`func (o *PrivateNetworkEndpointIdEntry) GetProvider() string` + +GetProvider returns the Provider field if non-nil, zero value otherwise. + +### GetProviderOk + +`func (o *PrivateNetworkEndpointIdEntry) GetProviderOk() (*string, bool)` + +GetProviderOk returns a tuple with the Provider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvider + +`func (o *PrivateNetworkEndpointIdEntry) SetProvider(v string)` + +SetProvider sets Provider field to given value. + +### HasProvider + +`func (o *PrivateNetworkEndpointIdEntry) HasProvider() bool` + +HasProvider returns a boolean if a field has been set. + +### GetType + +`func (o *PrivateNetworkEndpointIdEntry) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PrivateNetworkEndpointIdEntry) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PrivateNetworkEndpointIdEntry) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PrivateNetworkEndpointIdEntry) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ProgrammaticAPIKeysApi.md b/docs/docs/ProgrammaticAPIKeysApi.md new file mode 100644 index 00000000..173bb3a3 --- /dev/null +++ b/docs/docs/ProgrammaticAPIKeysApi.md @@ -0,0 +1,1130 @@ +# \ProgrammaticAPIKeysApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AddProjectApiKey**](ProgrammaticAPIKeysApi.md#AddProjectApiKey) | **Post** /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId} | Assign One Organization API Key to One Project +[**CreateApiKey**](ProgrammaticAPIKeysApi.md#CreateApiKey) | **Post** /api/atlas/v2/orgs/{orgId}/apiKeys | Create One Organization API Key +[**CreateApiKeyAccessList**](ProgrammaticAPIKeysApi.md#CreateApiKeyAccessList) | **Post** /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList | Create Access List Entries for One Organization API Key +[**CreateProjectApiKey**](ProgrammaticAPIKeysApi.md#CreateProjectApiKey) | **Post** /api/atlas/v2/groups/{groupId}/apiKeys | Create and Assign One Organization API Key to One Project +[**DeleteApiKey**](ProgrammaticAPIKeysApi.md#DeleteApiKey) | **Delete** /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId} | Remove One Organization API Key +[**DeleteApiKeyAccessListEntry**](ProgrammaticAPIKeysApi.md#DeleteApiKeyAccessListEntry) | **Delete** /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress} | Remove One Access List Entry for One Organization API Key +[**GetApiKey**](ProgrammaticAPIKeysApi.md#GetApiKey) | **Get** /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId} | Return One Organization API Key +[**GetApiKeyAccessList**](ProgrammaticAPIKeysApi.md#GetApiKeyAccessList) | **Get** /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress} | Return One Access List Entry for One Organization API Key +[**ListApiKeyAccessListsEntries**](ProgrammaticAPIKeysApi.md#ListApiKeyAccessListsEntries) | **Get** /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList | Return All Access List Entries for One Organization API Key +[**ListApiKeys**](ProgrammaticAPIKeysApi.md#ListApiKeys) | **Get** /api/atlas/v2/orgs/{orgId}/apiKeys | Return All Organization API Keys +[**ListProjectApiKeys**](ProgrammaticAPIKeysApi.md#ListProjectApiKeys) | **Get** /api/atlas/v2/groups/{groupId}/apiKeys | Return All Organization API Keys Assigned to One Project +[**RemoveProjectApiKey**](ProgrammaticAPIKeysApi.md#RemoveProjectApiKey) | **Delete** /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId} | Unassign One Organization API Key from One Project +[**UpdateApiKey**](ProgrammaticAPIKeysApi.md#UpdateApiKey) | **Patch** /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId} | Update One Organization API Key +[**UpdateApiKeyRoles**](ProgrammaticAPIKeysApi.md#UpdateApiKeyRoles) | **Patch** /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId} | Update Roles of One Organization API Key to One Project + + + +## AddProjectApiKey + +> ApiUser AddProjectApiKey(ctx, groupId, apiUserId).UserRoleAssignment(userRoleAssignment).Execute() + +Assign One Organization API Key to One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + apiUserId := "apiUserId_example" // string | + userRoleAssignment := []openapiclient.UserRoleAssignment{*openapiclient.NewUserRoleAssignment()} // []UserRoleAssignment | + + resp, r, err := sdk.ProgrammaticAPIKeysApi.AddProjectApiKey(context.Background(), groupId, apiUserId).UserRoleAssignment(userRoleAssignment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.AddProjectApiKey``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `AddProjectApiKey`: ApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.AddProjectApiKey`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddProjectApiKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **userRoleAssignment** | [**[]UserRoleAssignment**](UserRoleAssignment.md) | Organization API key to be assigned to the specified project. | + +### Return type + +[**ApiUser**](ApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateApiKey + +> ApiUser CreateApiKey(ctx, orgId).CreateApiKey(createApiKey).Execute() + +Create One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + createApiKey := *openapiclient.NewCreateApiKey() // CreateApiKey | + + resp, r, err := sdk.ProgrammaticAPIKeysApi.CreateApiKey(context.Background(), orgId).CreateApiKey(createApiKey).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.CreateApiKey``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateApiKey`: ApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.CreateApiKey`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateApiKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createApiKey** | [**CreateApiKey**](CreateApiKey.md) | Organization API Key to be created. This request requires a minimum of one of the two body parameters. | + +### Return type + +[**ApiUser**](ApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateApiKeyAccessList + +> UserAccessList CreateApiKeyAccessList(ctx, orgId, apiUserId).UserAccessList(userAccessList).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Create Access List Entries for One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + apiUserId := "apiUserId_example" // string | + userAccessList := []openapiclient.UserAccessList{*openapiclient.NewUserAccessList()} // []UserAccessList | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ProgrammaticAPIKeysApi.CreateApiKeyAccessList(context.Background(), orgId, apiUserId).UserAccessList(userAccessList).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.CreateApiKeyAccessList``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateApiKeyAccessList`: UserAccessList + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.CreateApiKeyAccessList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateApiKeyAccessListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **userAccessList** | [**[]UserAccessList**](UserAccessList.md) | Access list entries to be created for the specified organization API key. | + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**UserAccessList**](UserAccessList.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateProjectApiKey + +> ApiUser CreateProjectApiKey(ctx, groupId).CreateApiKey(createApiKey).Execute() + +Create and Assign One Organization API Key to One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + createApiKey := *openapiclient.NewCreateApiKey() // CreateApiKey | + + resp, r, err := sdk.ProgrammaticAPIKeysApi.CreateProjectApiKey(context.Background(), groupId).CreateApiKey(createApiKey).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.CreateProjectApiKey``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateProjectApiKey`: ApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.CreateProjectApiKey`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProjectApiKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createApiKey** | [**CreateApiKey**](CreateApiKey.md) | Organization API key to be created and assigned to the specified project. This request requires a minimum of one of the two body parameters. | + +### Return type + +[**ApiUser**](ApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteApiKey + +> DeleteApiKey(ctx, orgId, apiUserId).Execute() + +Remove One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + apiUserId := "apiUserId_example" // string | + + r, err := sdk.ProgrammaticAPIKeysApi.DeleteApiKey(context.Background(), orgId, apiUserId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.DeleteApiKey``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteApiKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteApiKeyAccessListEntry + +> DeleteApiKeyAccessListEntry(ctx, orgId, apiUserId, ipAddress).Execute() + +Remove One Access List Entry for One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + apiUserId := "apiUserId_example" // string | + ipAddress := "192.0.2.0%2F24" // string | + + r, err := sdk.ProgrammaticAPIKeysApi.DeleteApiKeyAccessListEntry(context.Background(), orgId, apiUserId, ipAddress).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.DeleteApiKeyAccessListEntry``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries. | +**ipAddress** | **string** | One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteApiKeyAccessListEntryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetApiKey + +> ApiUser GetApiKey(ctx, orgId, apiUserId).Execute() + +Return One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + apiUserId := "apiUserId_example" // string | + + resp, r, err := sdk.ProgrammaticAPIKeysApi.GetApiKey(context.Background(), orgId, apiUserId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.GetApiKey``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetApiKey`: ApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.GetApiKey`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key that you want to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApiKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ApiUser**](ApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetApiKeyAccessList + +> UserAccessList GetApiKeyAccessList(ctx, orgId, ipAddress, apiUserId).Execute() + +Return One Access List Entry for One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + ipAddress := "192.0.2.0%2F24" // string | + apiUserId := "apiUserId_example" // string | + + resp, r, err := sdk.ProgrammaticAPIKeysApi.GetApiKeyAccessList(context.Background(), orgId, ipAddress, apiUserId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.GetApiKeyAccessList``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetApiKeyAccessList`: UserAccessList + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.GetApiKeyAccessList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**ipAddress** | **string** | One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApiKeyAccessListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**UserAccessList**](UserAccessList.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListApiKeyAccessListsEntries + +> PaginatedApiUserAccessList ListApiKeyAccessListsEntries(ctx, orgId, apiUserId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Access List Entries for One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + apiUserId := "apiUserId_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ProgrammaticAPIKeysApi.ListApiKeyAccessListsEntries(context.Background(), orgId, apiUserId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.ListApiKeyAccessListsEntries``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListApiKeyAccessListsEntries`: PaginatedApiUserAccessList + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.ListApiKeyAccessListsEntries`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListApiKeyAccessListsEntriesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiUserAccessList**](PaginatedApiUserAccessList.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListApiKeys + +> PaginatedApiApiUser ListApiKeys(ctx, orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Organization API Keys + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ProgrammaticAPIKeysApi.ListApiKeys(context.Background(), orgId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.ListApiKeys``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListApiKeys`: PaginatedApiApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.ListApiKeys`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListApiKeysRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiApiUser**](PaginatedApiApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjectApiKeys + +> PaginatedApiApiUser ListProjectApiKeys(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Organization API Keys Assigned to One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ProgrammaticAPIKeysApi.ListProjectApiKeys(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.ListProjectApiKeys``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjectApiKeys`: PaginatedApiApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.ListProjectApiKeys`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectApiKeysRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiApiUser**](PaginatedApiApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RemoveProjectApiKey + +> RemoveProjectApiKey(ctx, groupId, apiUserId).Execute() + +Unassign One Organization API Key from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + apiUserId := "apiUserId_example" // string | + + r, err := sdk.ProgrammaticAPIKeysApi.RemoveProjectApiKey(context.Background(), groupId, apiUserId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.RemoveProjectApiKey``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRemoveProjectApiKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateApiKey + +> ApiUser UpdateApiKey(ctx, orgId, apiUserId).ApiUser(apiUser).Execute() + +Update One Organization API Key + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + apiUserId := "apiUserId_example" // string | + apiUser := *openapiclient.NewApiUser() // ApiUser | + + resp, r, err := sdk.ProgrammaticAPIKeysApi.UpdateApiKey(context.Background(), orgId, apiUserId).ApiUser(apiUser).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.UpdateApiKey``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateApiKey`: ApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.UpdateApiKey`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key you want to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateApiKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **apiUser** | [**ApiUser**](ApiUser.md) | Organization API key to be updated. This request requires a minimum of one of the two body parameters. | + +### Return type + +[**ApiUser**](ApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateApiKeyRoles + +> ApiUser UpdateApiKeyRoles(ctx, groupId, apiUserId).CreateApiKey(createApiKey).PageNum(pageNum).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).Execute() + +Update Roles of One Organization API Key to One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + apiUserId := "apiUserId_example" // string | + createApiKey := *openapiclient.NewCreateApiKey() // CreateApiKey | + pageNum := int(1) // int | (optional) (default to 1) + itemsPerPage := int(100) // int | (optional) (default to 100) + includeCount := true // bool | (optional) (default to true) + + resp, r, err := sdk.ProgrammaticAPIKeysApi.UpdateApiKeyRoles(context.Background(), groupId, apiUserId).CreateApiKey(createApiKey).PageNum(pageNum).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProgrammaticAPIKeysApi.UpdateApiKeyRoles``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateApiKeyRoles`: ApiUser + fmt.Fprintf(os.Stdout, "Response from `ProgrammaticAPIKeysApi.UpdateApiKeyRoles`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**apiUserId** | **string** | Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateApiKeyRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **createApiKey** | [**CreateApiKey**](CreateApiKey.md) | Organization API Key to be updated. This request requires a minimum of one of the two body parameters. | + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + +### Return type + +[**ApiUser**](ApiUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ProjectIPAccessListApi.md b/docs/docs/ProjectIPAccessListApi.md new file mode 100644 index 00000000..c22cb72e --- /dev/null +++ b/docs/docs/ProjectIPAccessListApi.md @@ -0,0 +1,404 @@ +# \ProjectIPAccessListApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateProjectIpAccessList**](ProjectIPAccessListApi.md#CreateProjectIpAccessList) | **Post** /api/atlas/v2/groups/{groupId}/accessList | Add Entries to Project IP Access List +[**DeleteProjectIpAccessList**](ProjectIPAccessListApi.md#DeleteProjectIpAccessList) | **Delete** /api/atlas/v2/groups/{groupId}/accessList/{entryValue} | Remove One Entry from One Project IP Access List +[**GetProjectIpAccessListStatus**](ProjectIPAccessListApi.md#GetProjectIpAccessListStatus) | **Get** /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status | Return Status of One Project IP Access List Entry +[**GetProjectIpList**](ProjectIPAccessListApi.md#GetProjectIpList) | **Get** /api/atlas/v2/groups/{groupId}/accessList/{entryValue} | Return One Project IP Access List Entry +[**ListProjectIpAccessLists**](ProjectIPAccessListApi.md#ListProjectIpAccessLists) | **Get** /api/atlas/v2/groups/{groupId}/accessList | Return Project IP Access List + + + +## CreateProjectIpAccessList + +> PaginatedNetworkAccess CreateProjectIpAccessList(ctx, groupId).NetworkPermissionEntry(networkPermissionEntry).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Add Entries to Project IP Access List + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + networkPermissionEntry := []openapiclient.NetworkPermissionEntry{*openapiclient.NewNetworkPermissionEntry()} // []NetworkPermissionEntry | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ProjectIPAccessListApi.CreateProjectIpAccessList(context.Background(), groupId).NetworkPermissionEntry(networkPermissionEntry).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectIPAccessListApi.CreateProjectIpAccessList``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateProjectIpAccessList`: PaginatedNetworkAccess + fmt.Fprintf(os.Stdout, "Response from `ProjectIPAccessListApi.CreateProjectIpAccessList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProjectIpAccessListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **networkPermissionEntry** | [**[]NetworkPermissionEntry**](NetworkPermissionEntry.md) | One or more access list entries to add to the specified project. | + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedNetworkAccess**](PaginatedNetworkAccess.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteProjectIpAccessList + +> DeleteProjectIpAccessList(ctx, groupId, entryValue).Execute() + +Remove One Entry from One Project IP Access List + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + entryValue := "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8" // string | + + r, err := sdk.ProjectIPAccessListApi.DeleteProjectIpAccessList(context.Background(), groupId, entryValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectIPAccessListApi.DeleteProjectIpAccessList``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**entryValue** | **string** | Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including: - how your application established the connection, - how MongoDB Cloud or the driver using the address behaves, and - which protocol (like TCP or UDP) the connection uses. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProjectIpAccessListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProjectIpAccessListStatus + +> NetworkPermissionEntryStatus GetProjectIpAccessListStatus(ctx, groupId, entryValue).Execute() + +Return Status of One Project IP Access List Entry + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + entryValue := "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8" // string | + + resp, r, err := sdk.ProjectIPAccessListApi.GetProjectIpAccessListStatus(context.Background(), groupId, entryValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectIPAccessListApi.GetProjectIpAccessListStatus``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProjectIpAccessListStatus`: NetworkPermissionEntryStatus + fmt.Fprintf(os.Stdout, "Response from `ProjectIPAccessListApi.GetProjectIpAccessListStatus`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**entryValue** | **string** | Network address or cloud provider security construct that identifies which project access list entry to be verified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectIpAccessListStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NetworkPermissionEntryStatus**](NetworkPermissionEntryStatus.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProjectIpList + +> NetworkPermissionEntry GetProjectIpList(ctx, groupId, entryValue).Execute() + +Return One Project IP Access List Entry + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + entryValue := "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8" // string | + + resp, r, err := sdk.ProjectIPAccessListApi.GetProjectIpList(context.Background(), groupId, entryValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectIPAccessListApi.GetProjectIpList``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProjectIpList`: NetworkPermissionEntry + fmt.Fprintf(os.Stdout, "Response from `ProjectIPAccessListApi.GetProjectIpList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**entryValue** | **string** | Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectIpListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NetworkPermissionEntry**](NetworkPermissionEntry.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjectIpAccessLists + +> PaginatedNetworkAccess ListProjectIpAccessLists(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return Project IP Access List + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ProjectIPAccessListApi.ListProjectIpAccessLists(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectIPAccessListApi.ListProjectIpAccessLists``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjectIpAccessLists`: PaginatedNetworkAccess + fmt.Fprintf(os.Stdout, "Response from `ProjectIPAccessListApi.ListProjectIpAccessLists`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectIpAccessListsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedNetworkAccess**](PaginatedNetworkAccess.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ProjectSettingItem.md b/docs/docs/ProjectSettingItem.md new file mode 100644 index 00000000..da061816 --- /dev/null +++ b/docs/docs/ProjectSettingItem.md @@ -0,0 +1,51 @@ +# ProjectSettingItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **bool** | Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project. - Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations: - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime. - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project. - You can't disable this setting if you have: - more than one private endpoint in more than one region - more than one private endpoint in one region and one private endpoint in one or more regions. - Set this value to `false` to disable regionalized private endpoints. | + +## Methods + +### NewProjectSettingItem + +`func NewProjectSettingItem(enabled bool, ) *ProjectSettingItem` + +NewProjectSettingItem instantiates a new ProjectSettingItem object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProjectSettingItemWithDefaults + +`func NewProjectSettingItemWithDefaults() *ProjectSettingItem` + +NewProjectSettingItemWithDefaults instantiates a new ProjectSettingItem object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *ProjectSettingItem) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ProjectSettingItem) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ProjectSettingItem) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ProjectsApi.md b/docs/docs/ProjectsApi.md new file mode 100644 index 00000000..5d3d989c --- /dev/null +++ b/docs/docs/ProjectsApi.md @@ -0,0 +1,1543 @@ +# \ProjectsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateProject**](ProjectsApi.md#CreateProject) | **Post** /api/atlas/v2/groups | Create One Project +[**CreateProjectInvitation**](ProjectsApi.md#CreateProjectInvitation) | **Post** /api/atlas/v2/groups/{groupId}/invites | Invite One MongoDB Cloud User to Join One Project +[**DeleteProject**](ProjectsApi.md#DeleteProject) | **Delete** /api/atlas/v2/groups/{groupId} | Remove One Project +[**DeleteProjectInvitation**](ProjectsApi.md#DeleteProjectInvitation) | **Delete** /api/atlas/v2/groups/{groupId}/invites/{invitationId} | Cancel One Project Invitation +[**DeleteProjectLimit**](ProjectsApi.md#DeleteProjectLimit) | **Delete** /api/atlas/v2/groups/{groupId}/limits/{limitName} | Remove One Project Limit +[**GetProject**](ProjectsApi.md#GetProject) | **Get** /api/atlas/v2/groups/{groupId} | Return One Project +[**GetProjectByName**](ProjectsApi.md#GetProjectByName) | **Get** /api/atlas/v2/groups/byName/{groupName} | Return One Project using Its Name +[**GetProjectInvitation**](ProjectsApi.md#GetProjectInvitation) | **Get** /api/atlas/v2/groups/{groupId}/invites/{invitationId} | Return One Project Invitation +[**GetProjectLimit**](ProjectsApi.md#GetProjectLimit) | **Get** /api/atlas/v2/groups/{groupId}/limits/{limitName} | Return One Limit for One Project +[**GetProjectSettings**](ProjectsApi.md#GetProjectSettings) | **Get** /api/atlas/v2/groups/{groupId}/settings | Return One Project Settings +[**ListProjectInvitations**](ProjectsApi.md#ListProjectInvitations) | **Get** /api/atlas/v2/groups/{groupId}/invites | Return All Project Invitations +[**ListProjectLimits**](ProjectsApi.md#ListProjectLimits) | **Get** /api/atlas/v2/groups/{groupId}/limits | Return All Limits for One Project +[**ListProjectUsers**](ProjectsApi.md#ListProjectUsers) | **Get** /api/atlas/v2/groups/{groupId}/users | Return All Users in One Project +[**ListProjects**](ProjectsApi.md#ListProjects) | **Get** /api/atlas/v2/groups | Return All Projects +[**RemoveProjectUser**](ProjectsApi.md#RemoveProjectUser) | **Delete** /api/atlas/v2/groups/{groupId}/users/{userId} | Remove One User from One Project +[**SetProjectLimit**](ProjectsApi.md#SetProjectLimit) | **Patch** /api/atlas/v2/groups/{groupId}/limits/{limitName} | Set One Project Limit +[**UpdateProject**](ProjectsApi.md#UpdateProject) | **Patch** /api/atlas/v2/groups/{groupId} | Update One Project Name +[**UpdateProjectInvitation**](ProjectsApi.md#UpdateProjectInvitation) | **Patch** /api/atlas/v2/groups/{groupId}/invites | Update One Project Invitation +[**UpdateProjectInvitationById**](ProjectsApi.md#UpdateProjectInvitationById) | **Patch** /api/atlas/v2/groups/{groupId}/invites/{invitationId} | Update One Project Invitation by Invitation ID +[**UpdateProjectSettings**](ProjectsApi.md#UpdateProjectSettings) | **Patch** /api/atlas/v2/groups/{groupId}/settings | Update One Project Settings + + + +## CreateProject + +> Group CreateProject(ctx).Group(group).ProjectOwnerId(projectOwnerId).Execute() + +Create One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + group := *openapiclient.NewGroup(int64(123), time.Now(), "Name_example", "32b6e34b3d91647abb20e7b8") // Group | + projectOwnerId := "projectOwnerId_example" // string | (optional) + + resp, r, err := sdk.ProjectsApi.CreateProject(context.Background()).Group(group).ProjectOwnerId(projectOwnerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.CreateProject``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateProject`: Group + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.CreateProject`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | [**Group**](Group.md) | Creates one project. | + **projectOwnerId** | **string** | Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner. | + +### Return type + +[**Group**](Group.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateProjectInvitation + +> GroupInvitation CreateProjectInvitation(ctx, groupId).GroupInvitationRequest(groupInvitationRequest).Execute() + +Invite One MongoDB Cloud User to Join One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + groupInvitationRequest := *openapiclient.NewGroupInvitationRequest() // GroupInvitationRequest | + + resp, r, err := sdk.ProjectsApi.CreateProjectInvitation(context.Background(), groupId).GroupInvitationRequest(groupInvitationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.CreateProjectInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateProjectInvitation`: GroupInvitation + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.CreateProjectInvitation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProjectInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **groupInvitationRequest** | [**GroupInvitationRequest**](GroupInvitationRequest.md) | Invites one MongoDB Cloud user to join the specified project. | + +### Return type + +[**GroupInvitation**](GroupInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteProject + +> DeleteProject(ctx, groupId).Execute() + +Remove One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.ProjectsApi.DeleteProject(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.DeleteProject``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteProjectInvitation + +> DeleteProjectInvitation(ctx, groupId, invitationId).Execute() + +Cancel One Project Invitation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + invitationId := "invitationId_example" // string | + + r, err := sdk.ProjectsApi.DeleteProjectInvitation(context.Background(), groupId, invitationId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.DeleteProjectInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**invitationId** | **string** | Unique 24-hexadecimal digit string that identifies the invitation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProjectInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteProjectLimit + +> DeleteProjectLimit(ctx, limitName, groupId).Execute() + +Remove One Project Limit + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + limitName := "limitName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.ProjectsApi.DeleteProjectLimit(context.Background(), limitName, groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.DeleteProjectLimit``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**limitName** | **string** | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProjectLimitRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProject + +> Group GetProject(ctx, groupId).Execute() + +Return One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.ProjectsApi.GetProject(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.GetProject``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProject`: Group + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.GetProject`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Group**](Group.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProjectByName + +> Group GetProjectByName(ctx, groupName).Execute() + +Return One Project using Its Name + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupName := "groupName_example" // string | + + resp, r, err := sdk.ProjectsApi.GetProjectByName(context.Background(), groupName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.GetProjectByName``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProjectByName`: Group + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.GetProjectByName`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupName** | **string** | Human-readable label that identifies this project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectByNameRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Group**](Group.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProjectInvitation + +> GroupInvitation GetProjectInvitation(ctx, groupId, invitationId).Execute() + +Return One Project Invitation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + invitationId := "invitationId_example" // string | + + resp, r, err := sdk.ProjectsApi.GetProjectInvitation(context.Background(), groupId, invitationId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.GetProjectInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProjectInvitation`: GroupInvitation + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.GetProjectInvitation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**invitationId** | **string** | Unique 24-hexadecimal digit string that identifies the invitation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**GroupInvitation**](GroupInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProjectLimit + +> Limit GetProjectLimit(ctx, limitName, groupId).Execute() + +Return One Limit for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + limitName := "limitName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.ProjectsApi.GetProjectLimit(context.Background(), limitName, groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.GetProjectLimit``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProjectLimit`: Limit + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.GetProjectLimit`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**limitName** | **string** | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectLimitRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Limit**](Limit.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetProjectSettings + +> GroupSettings GetProjectSettings(ctx, groupId).Execute() + +Return One Project Settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.ProjectsApi.GetProjectSettings(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.GetProjectSettings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetProjectSettings`: GroupSettings + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.GetProjectSettings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProjectSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GroupSettings**](GroupSettings.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjectInvitations + +> []GroupInvitation ListProjectInvitations(ctx, groupId).Username(username).Execute() + +Return All Project Invitations + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + username := "username_example" // string | (optional) + + resp, r, err := sdk.ProjectsApi.ListProjectInvitations(context.Background(), groupId).Username(username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.ListProjectInvitations``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjectInvitations`: []GroupInvitation + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.ListProjectInvitations`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectInvitationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **username** | **string** | Email address of the user account invited to this project. | + +### Return type + +[**[]GroupInvitation**](GroupInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjectLimits + +> Limit ListProjectLimits(ctx, groupId).Execute() + +Return All Limits for One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.ProjectsApi.ListProjectLimits(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.ListProjectLimits``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjectLimits`: Limit + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.ListProjectLimits`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectLimitsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Limit**](Limit.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjectUsers + +> PaginatedApiAppUser ListProjectUsers(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).FlattenTeams(flattenTeams).IncludeOrgUsers(includeOrgUsers).Execute() + +Return All Users in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + flattenTeams := true // bool | (optional) (default to false) + includeOrgUsers := true // bool | (optional) (default to false) + + resp, r, err := sdk.ProjectsApi.ListProjectUsers(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).FlattenTeams(flattenTeams).IncludeOrgUsers(includeOrgUsers).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.ListProjectUsers``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjectUsers`: PaginatedApiAppUser + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.ListProjectUsers`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectUsersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + **flattenTeams** | **bool** | Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project. | [default to false] + **includeOrgUsers** | **bool** | Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role. | [default to false] + +### Return type + +[**PaginatedApiAppUser**](PaginatedApiAppUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjects + +> PaginatedAtlasGroup ListProjects(ctx).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Projects + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ProjectsApi.ListProjects(context.Background()).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.ListProjects``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjects`: PaginatedAtlasGroup + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.ListProjects`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedAtlasGroup**](PaginatedAtlasGroup.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RemoveProjectUser + +> RemoveProjectUser(ctx, groupId, userId).Execute() + +Remove One User from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + userId := "userId_example" // string | + + r, err := sdk.ProjectsApi.RemoveProjectUser(context.Background(), groupId, userId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.RemoveProjectUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**userId** | **string** | Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRemoveProjectUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## SetProjectLimit + +> Limit SetProjectLimit(ctx, limitName, groupId).Limit(limit).Execute() + +Set One Project Limit + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + limitName := "limitName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + limit := openapiclient.Limit{DataFederationQueryLimit: openapiclient.NewDataFederationQueryLimit("Name_example", int64(123))} // Limit | (optional) + + resp, r, err := sdk.ProjectsApi.SetProjectLimit(context.Background(), limitName, groupId).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.SetProjectLimit``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `SetProjectLimit`: Limit + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.SetProjectLimit`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**limitName** | **string** | Human-readable label that identifies this project limit. | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | | atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 | | atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 | | atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 | | atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 | | atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 | | dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A | | dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A | | dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A | | dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A | | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetProjectLimitRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **limit** | [**Limit**](Limit.md) | | + +### Return type + +[**Limit**](Limit.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateProject + +> Group UpdateProject(ctx, groupId).GroupName(groupName).Execute() + +Update One Project Name + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + groupName := *openapiclient.NewGroupName() // GroupName | (optional) + + resp, r, err := sdk.ProjectsApi.UpdateProject(context.Background(), groupId).GroupName(groupName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.UpdateProject``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateProject`: Group + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.UpdateProject`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **groupName** | [**GroupName**](GroupName.md) | | + +### Return type + +[**Group**](Group.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateProjectInvitation + +> GroupInvitation UpdateProjectInvitation(ctx, groupId).GroupInvitationRequest(groupInvitationRequest).Execute() + +Update One Project Invitation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + groupInvitationRequest := *openapiclient.NewGroupInvitationRequest() // GroupInvitationRequest | + + resp, r, err := sdk.ProjectsApi.UpdateProjectInvitation(context.Background(), groupId).GroupInvitationRequest(groupInvitationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.UpdateProjectInvitation``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateProjectInvitation`: GroupInvitation + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.UpdateProjectInvitation`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProjectInvitationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **groupInvitationRequest** | [**GroupInvitationRequest**](GroupInvitationRequest.md) | Updates the details of one pending invitation to the specified project. | + +### Return type + +[**GroupInvitation**](GroupInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateProjectInvitationById + +> GroupInvitation UpdateProjectInvitationById(ctx, groupId, invitationId).GroupInvitationUpdateRequest(groupInvitationUpdateRequest).Execute() + +Update One Project Invitation by Invitation ID + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + invitationId := "invitationId_example" // string | + groupInvitationUpdateRequest := *openapiclient.NewGroupInvitationUpdateRequest() // GroupInvitationUpdateRequest | + + resp, r, err := sdk.ProjectsApi.UpdateProjectInvitationById(context.Background(), groupId, invitationId).GroupInvitationUpdateRequest(groupInvitationUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.UpdateProjectInvitationById``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateProjectInvitationById`: GroupInvitation + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.UpdateProjectInvitationById`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**invitationId** | **string** | Unique 24-hexadecimal digit string that identifies the invitation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProjectInvitationByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **groupInvitationUpdateRequest** | [**GroupInvitationUpdateRequest**](GroupInvitationUpdateRequest.md) | Updates the details of one pending invitation to the specified project. | + +### Return type + +[**GroupInvitation**](GroupInvitation.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateProjectSettings + +> GroupSettings UpdateProjectSettings(ctx, groupId).GroupSettings(groupSettings).Execute() + +Update One Project Settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + groupSettings := *openapiclient.NewGroupSettings() // GroupSettings | (optional) + + resp, r, err := sdk.ProjectsApi.UpdateProjectSettings(context.Background(), groupId).GroupSettings(groupSettings).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ProjectsApi.UpdateProjectSettings``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateProjectSettings`: GroupSettings + fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.UpdateProjectSettings`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProjectSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **groupSettings** | [**GroupSettings**](GroupSettings.md) | | + +### Return type + +[**GroupSettings**](GroupSettings.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/Prometheus.md b/docs/docs/Prometheus.md new file mode 100644 index 00000000..fcbcc78d --- /dev/null +++ b/docs/docs/Prometheus.md @@ -0,0 +1,244 @@ +# Prometheus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **bool** | Flag that indicates whether someone has activated the Prometheus integration. | +**ListenAddress** | Pointer to **string** | Combination of IPv4 address and Internet Assigned Numbers Authority (IANA) port or the IANA port alone to which Prometheus binds to ingest MongoDB metrics. | [optional] [default to ":9216"] +**Password** | Pointer to **string** | | [optional] +**RateLimitInterval** | Pointer to **int** | | [optional] +**Scheme** | **string** | Security Scheme to apply to HyperText Transfer Protocol (HTTP) traffic between Prometheus and MongoDB Cloud. | +**ServiceDiscovery** | **string** | Desired method to discover the Prometheus service. | +**TlsPemPath** | Pointer to **string** | Root-relative path to the Transport Layer Security (TLS) Privacy Enhanced Mail (PEM) key and certificate file on the host. | [optional] +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] +**Username** | **string** | Human-readable label that identifies your Prometheus incoming webhook. | + +## Methods + +### NewPrometheus + +`func NewPrometheus(enabled bool, scheme string, serviceDiscovery string, username string, ) *Prometheus` + +NewPrometheus instantiates a new Prometheus object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPrometheusWithDefaults + +`func NewPrometheusWithDefaults() *Prometheus` + +NewPrometheusWithDefaults instantiates a new Prometheus object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *Prometheus) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Prometheus) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Prometheus) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetListenAddress + +`func (o *Prometheus) GetListenAddress() string` + +GetListenAddress returns the ListenAddress field if non-nil, zero value otherwise. + +### GetListenAddressOk + +`func (o *Prometheus) GetListenAddressOk() (*string, bool)` + +GetListenAddressOk returns a tuple with the ListenAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetListenAddress + +`func (o *Prometheus) SetListenAddress(v string)` + +SetListenAddress sets ListenAddress field to given value. + +### HasListenAddress + +`func (o *Prometheus) HasListenAddress() bool` + +HasListenAddress returns a boolean if a field has been set. + +### GetPassword + +`func (o *Prometheus) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *Prometheus) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *Prometheus) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *Prometheus) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetRateLimitInterval + +`func (o *Prometheus) GetRateLimitInterval() int` + +GetRateLimitInterval returns the RateLimitInterval field if non-nil, zero value otherwise. + +### GetRateLimitIntervalOk + +`func (o *Prometheus) GetRateLimitIntervalOk() (*int, bool)` + +GetRateLimitIntervalOk returns a tuple with the RateLimitInterval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRateLimitInterval + +`func (o *Prometheus) SetRateLimitInterval(v int)` + +SetRateLimitInterval sets RateLimitInterval field to given value. + +### HasRateLimitInterval + +`func (o *Prometheus) HasRateLimitInterval() bool` + +HasRateLimitInterval returns a boolean if a field has been set. + +### GetScheme + +`func (o *Prometheus) GetScheme() string` + +GetScheme returns the Scheme field if non-nil, zero value otherwise. + +### GetSchemeOk + +`func (o *Prometheus) GetSchemeOk() (*string, bool)` + +GetSchemeOk returns a tuple with the Scheme field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheme + +`func (o *Prometheus) SetScheme(v string)` + +SetScheme sets Scheme field to given value. + + +### GetServiceDiscovery + +`func (o *Prometheus) GetServiceDiscovery() string` + +GetServiceDiscovery returns the ServiceDiscovery field if non-nil, zero value otherwise. + +### GetServiceDiscoveryOk + +`func (o *Prometheus) GetServiceDiscoveryOk() (*string, bool)` + +GetServiceDiscoveryOk returns a tuple with the ServiceDiscovery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceDiscovery + +`func (o *Prometheus) SetServiceDiscovery(v string)` + +SetServiceDiscovery sets ServiceDiscovery field to given value. + + +### GetTlsPemPath + +`func (o *Prometheus) GetTlsPemPath() string` + +GetTlsPemPath returns the TlsPemPath field if non-nil, zero value otherwise. + +### GetTlsPemPathOk + +`func (o *Prometheus) GetTlsPemPathOk() (*string, bool)` + +GetTlsPemPathOk returns a tuple with the TlsPemPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTlsPemPath + +`func (o *Prometheus) SetTlsPemPath(v string)` + +SetTlsPemPath sets TlsPemPath field to given value. + +### HasTlsPemPath + +`func (o *Prometheus) HasTlsPemPath() bool` + +HasTlsPemPath returns a boolean if a field has been set. + +### GetType + +`func (o *Prometheus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Prometheus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Prometheus) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Prometheus) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUsername + +`func (o *Prometheus) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *Prometheus) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *Prometheus) SetUsername(v string)` + +SetUsername sets Username field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ProviderRegions.md b/docs/docs/ProviderRegions.md new file mode 100644 index 00000000..e6412847 --- /dev/null +++ b/docs/docs/ProviderRegions.md @@ -0,0 +1,82 @@ +# ProviderRegions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InstanceSizes** | Pointer to [**[]InstanceSize**](InstanceSize.md) | List of instances sizes that this cloud provider supports. | [optional] [readonly] +**Provider** | Pointer to **string** | Human-readable label that identifies the Cloud provider. | [optional] + +## Methods + +### NewProviderRegions + +`func NewProviderRegions() *ProviderRegions` + +NewProviderRegions instantiates a new ProviderRegions object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProviderRegionsWithDefaults + +`func NewProviderRegionsWithDefaults() *ProviderRegions` + +NewProviderRegionsWithDefaults instantiates a new ProviderRegions object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInstanceSizes + +`func (o *ProviderRegions) GetInstanceSizes() []InstanceSize` + +GetInstanceSizes returns the InstanceSizes field if non-nil, zero value otherwise. + +### GetInstanceSizesOk + +`func (o *ProviderRegions) GetInstanceSizesOk() (*[]InstanceSize, bool)` + +GetInstanceSizesOk returns a tuple with the InstanceSizes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSizes + +`func (o *ProviderRegions) SetInstanceSizes(v []InstanceSize)` + +SetInstanceSizes sets InstanceSizes field to given value. + +### HasInstanceSizes + +`func (o *ProviderRegions) HasInstanceSizes() bool` + +HasInstanceSizes returns a boolean if a field has been set. + +### GetProvider + +`func (o *ProviderRegions) GetProvider() string` + +GetProvider returns the Provider field if non-nil, zero value otherwise. + +### GetProviderOk + +`func (o *ProviderRegions) GetProviderOk() (*string, bool)` + +GetProviderOk returns a tuple with the Provider field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvider + +`func (o *ProviderRegions) SetProvider(v string)` + +SetProvider sets Provider field to given value. + +### HasProvider + +`func (o *ProviderRegions) HasProvider() bool` + +HasProvider returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RPUMetricThreshold.md b/docs/docs/RPUMetricThreshold.md new file mode 100644 index 00000000..7ea62321 --- /dev/null +++ b/docs/docs/RPUMetricThreshold.md @@ -0,0 +1,160 @@ +# RPUMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**ServerlessMetricUnits**](ServerlessMetricUnits.md) | | [optional] + +## Methods + +### NewRPUMetricThreshold + +`func NewRPUMetricThreshold() *RPUMetricThreshold` + +NewRPUMetricThreshold instantiates a new RPUMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRPUMetricThresholdWithDefaults + +`func NewRPUMetricThresholdWithDefaults() *RPUMetricThreshold` + +NewRPUMetricThresholdWithDefaults instantiates a new RPUMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *RPUMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *RPUMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *RPUMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *RPUMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *RPUMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *RPUMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *RPUMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *RPUMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *RPUMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *RPUMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *RPUMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *RPUMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *RPUMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *RPUMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *RPUMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *RPUMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *RPUMetricThreshold) GetUnits() ServerlessMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *RPUMetricThreshold) GetUnitsOk() (*ServerlessMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *RPUMetricThreshold) SetUnits(v ServerlessMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *RPUMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Raw.md b/docs/docs/Raw.md new file mode 100644 index 00000000..e8387d27 --- /dev/null +++ b/docs/docs/Raw.md @@ -0,0 +1,290 @@ +# Raw + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**T** | Pointer to **string** | Unique identifier of event type. | [optional] +**AlertConfigId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the alert configuration related to the event. | [optional] [readonly] +**Cid** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. | [optional] [readonly] +**Cre** | Pointer to **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Description** | Pointer to **string** | Description of the event. | [optional] +**Gn** | Pointer to **string** | Human-readable label that identifies the project. | [optional] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the event. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**OrgName** | Pointer to **string** | Human-readable label that identifies the organization that contains the project. | [optional] +**Severity** | Pointer to **string** | | [optional] + +## Methods + +### NewRaw + +`func NewRaw() *Raw` + +NewRaw instantiates a new Raw object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRawWithDefaults + +`func NewRawWithDefaults() *Raw` + +NewRawWithDefaults instantiates a new Raw object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetT + +`func (o *Raw) GetT() string` + +GetT returns the T field if non-nil, zero value otherwise. + +### GetTOk + +`func (o *Raw) GetTOk() (*string, bool)` + +GetTOk returns a tuple with the T field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetT + +`func (o *Raw) SetT(v string)` + +SetT sets T field to given value. + +### HasT + +`func (o *Raw) HasT() bool` + +HasT returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *Raw) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *Raw) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *Raw) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + +### HasAlertConfigId + +`func (o *Raw) HasAlertConfigId() bool` + +HasAlertConfigId returns a boolean if a field has been set. + +### GetCid + +`func (o *Raw) GetCid() string` + +GetCid returns the Cid field if non-nil, zero value otherwise. + +### GetCidOk + +`func (o *Raw) GetCidOk() (*string, bool)` + +GetCidOk returns a tuple with the Cid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCid + +`func (o *Raw) SetCid(v string)` + +SetCid sets Cid field to given value. + +### HasCid + +`func (o *Raw) HasCid() bool` + +HasCid returns a boolean if a field has been set. + +### GetCre + +`func (o *Raw) GetCre() time.Time` + +GetCre returns the Cre field if non-nil, zero value otherwise. + +### GetCreOk + +`func (o *Raw) GetCreOk() (*time.Time, bool)` + +GetCreOk returns a tuple with the Cre field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCre + +`func (o *Raw) SetCre(v time.Time)` + +SetCre sets Cre field to given value. + +### HasCre + +`func (o *Raw) HasCre() bool` + +HasCre returns a boolean if a field has been set. + +### GetDescription + +`func (o *Raw) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Raw) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Raw) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Raw) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetGn + +`func (o *Raw) GetGn() string` + +GetGn returns the Gn field if non-nil, zero value otherwise. + +### GetGnOk + +`func (o *Raw) GetGnOk() (*string, bool)` + +GetGnOk returns a tuple with the Gn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGn + +`func (o *Raw) SetGn(v string)` + +SetGn sets Gn field to given value. + +### HasGn + +`func (o *Raw) HasGn() bool` + +HasGn returns a boolean if a field has been set. + +### GetId + +`func (o *Raw) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Raw) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Raw) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Raw) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetOrgId + +`func (o *Raw) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *Raw) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *Raw) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *Raw) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetOrgName + +`func (o *Raw) GetOrgName() string` + +GetOrgName returns the OrgName field if non-nil, zero value otherwise. + +### GetOrgNameOk + +`func (o *Raw) GetOrgNameOk() (*string, bool)` + +GetOrgNameOk returns a tuple with the OrgName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgName + +`func (o *Raw) SetOrgName(v string)` + +SetOrgName sets OrgName field to given value. + +### HasOrgName + +`func (o *Raw) HasOrgName() bool` + +HasOrgName returns a boolean if a field has been set. + +### GetSeverity + +`func (o *Raw) GetSeverity() string` + +GetSeverity returns the Severity field if non-nil, zero value otherwise. + +### GetSeverityOk + +`func (o *Raw) GetSeverityOk() (*string, bool)` + +GetSeverityOk returns a tuple with the Severity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSeverity + +`func (o *Raw) SetSeverity(v string)` + +SetSeverity sets Severity field to given value. + +### HasSeverity + +`func (o *Raw) HasSeverity() bool` + +HasSeverity returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RawMetricAlert.md b/docs/docs/RawMetricAlert.md new file mode 100644 index 00000000..ec75925b --- /dev/null +++ b/docs/docs/RawMetricAlert.md @@ -0,0 +1,489 @@ +# RawMetricAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**RawMetricValue**](RawMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventTypeViewAlertable**](HostMetricEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see <a href=\"https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types\" target=\"_blank\">Host Metrics</a>. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href=\"https://dochub.mongodb.org/core/alert-config-serverless-measurements\" target=\"_blank\">Serverless Measurements</a>. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewRawMetricAlert + +`func NewRawMetricAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName HostMetricEventTypeViewAlertable, id string, status string, updated time.Time, ) *RawMetricAlert` + +NewRawMetricAlert instantiates a new RawMetricAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRawMetricAlertWithDefaults + +`func NewRawMetricAlertWithDefaults() *RawMetricAlert` + +NewRawMetricAlertWithDefaults instantiates a new RawMetricAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *RawMetricAlert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *RawMetricAlert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *RawMetricAlert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *RawMetricAlert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *RawMetricAlert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *RawMetricAlert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *RawMetricAlert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *RawMetricAlert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *RawMetricAlert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *RawMetricAlert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *RawMetricAlert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *RawMetricAlert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *RawMetricAlert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *RawMetricAlert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *RawMetricAlert) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *RawMetricAlert) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *RawMetricAlert) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *RawMetricAlert) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *RawMetricAlert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RawMetricAlert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RawMetricAlert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *RawMetricAlert) GetCurrentValue() RawMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *RawMetricAlert) GetCurrentValueOk() (*RawMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *RawMetricAlert) SetCurrentValue(v RawMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *RawMetricAlert) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *RawMetricAlert) GetEventTypeName() HostMetricEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *RawMetricAlert) GetEventTypeNameOk() (*HostMetricEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *RawMetricAlert) SetEventTypeName(v HostMetricEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *RawMetricAlert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *RawMetricAlert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *RawMetricAlert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *RawMetricAlert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *RawMetricAlert) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *RawMetricAlert) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *RawMetricAlert) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *RawMetricAlert) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetId + +`func (o *RawMetricAlert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RawMetricAlert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RawMetricAlert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *RawMetricAlert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *RawMetricAlert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *RawMetricAlert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *RawMetricAlert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *RawMetricAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *RawMetricAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *RawMetricAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *RawMetricAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *RawMetricAlert) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *RawMetricAlert) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *RawMetricAlert) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *RawMetricAlert) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *RawMetricAlert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *RawMetricAlert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *RawMetricAlert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *RawMetricAlert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *RawMetricAlert) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *RawMetricAlert) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *RawMetricAlert) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *RawMetricAlert) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetResolved + +`func (o *RawMetricAlert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *RawMetricAlert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *RawMetricAlert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *RawMetricAlert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *RawMetricAlert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RawMetricAlert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RawMetricAlert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *RawMetricAlert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *RawMetricAlert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *RawMetricAlert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RawMetricEvent.md b/docs/docs/RawMetricEvent.md new file mode 100644 index 00000000..bff65cf8 --- /dev/null +++ b/docs/docs/RawMetricEvent.md @@ -0,0 +1,483 @@ +# RawMetricEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**RawMetricValue**](RawMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventType**](HostMetricEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewRawMetricEvent + +`func NewRawMetricEvent(created time.Time, eventTypeName HostMetricEventType, id string, ) *RawMetricEvent` + +NewRawMetricEvent instantiates a new RawMetricEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRawMetricEventWithDefaults + +`func NewRawMetricEventWithDefaults() *RawMetricEvent` + +NewRawMetricEventWithDefaults instantiates a new RawMetricEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *RawMetricEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *RawMetricEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *RawMetricEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *RawMetricEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *RawMetricEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RawMetricEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RawMetricEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *RawMetricEvent) GetCurrentValue() RawMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *RawMetricEvent) GetCurrentValueOk() (*RawMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *RawMetricEvent) SetCurrentValue(v RawMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *RawMetricEvent) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *RawMetricEvent) GetEventTypeName() HostMetricEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *RawMetricEvent) GetEventTypeNameOk() (*HostMetricEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *RawMetricEvent) SetEventTypeName(v HostMetricEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *RawMetricEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *RawMetricEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *RawMetricEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *RawMetricEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *RawMetricEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RawMetricEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RawMetricEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *RawMetricEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *RawMetricEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *RawMetricEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *RawMetricEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *RawMetricEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *RawMetricEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *RawMetricEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *RawMetricEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *RawMetricEvent) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *RawMetricEvent) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *RawMetricEvent) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *RawMetricEvent) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *RawMetricEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *RawMetricEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *RawMetricEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *RawMetricEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPort + +`func (o *RawMetricEvent) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *RawMetricEvent) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *RawMetricEvent) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *RawMetricEvent) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *RawMetricEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *RawMetricEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *RawMetricEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *RawMetricEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *RawMetricEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *RawMetricEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *RawMetricEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *RawMetricEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *RawMetricEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *RawMetricEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *RawMetricEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *RawMetricEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *RawMetricEvent) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *RawMetricEvent) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *RawMetricEvent) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *RawMetricEvent) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *RawMetricEvent) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *RawMetricEvent) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *RawMetricEvent) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *RawMetricEvent) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetUserId + +`func (o *RawMetricEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *RawMetricEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *RawMetricEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *RawMetricEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *RawMetricEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *RawMetricEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *RawMetricEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *RawMetricEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RawMetricThreshold.md b/docs/docs/RawMetricThreshold.md new file mode 100644 index 00000000..d01d68db --- /dev/null +++ b/docs/docs/RawMetricThreshold.md @@ -0,0 +1,160 @@ +# RawMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**RawMetricUnits**](RawMetricUnits.md) | | [optional] [default to RAWMETRICUNITS_RAW] + +## Methods + +### NewRawMetricThreshold + +`func NewRawMetricThreshold() *RawMetricThreshold` + +NewRawMetricThreshold instantiates a new RawMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRawMetricThresholdWithDefaults + +`func NewRawMetricThresholdWithDefaults() *RawMetricThreshold` + +NewRawMetricThresholdWithDefaults instantiates a new RawMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *RawMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *RawMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *RawMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *RawMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *RawMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *RawMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *RawMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *RawMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *RawMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *RawMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *RawMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *RawMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *RawMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *RawMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *RawMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *RawMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *RawMetricThreshold) GetUnits() RawMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *RawMetricThreshold) GetUnitsOk() (*RawMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *RawMetricThreshold) SetUnits(v RawMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *RawMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RawMetricUnits.md b/docs/docs/RawMetricUnits.md new file mode 100644 index 00000000..9dfafc29 --- /dev/null +++ b/docs/docs/RawMetricUnits.md @@ -0,0 +1,11 @@ +# RawMetricUnits + +## Enum + + +* `RAW` (value: `"RAW"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RawMetricValue.md b/docs/docs/RawMetricValue.md new file mode 100644 index 00000000..fbffae40 --- /dev/null +++ b/docs/docs/RawMetricValue.md @@ -0,0 +1,82 @@ +# RawMetricValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **float64** | Amount of the **metricName** recorded at the time of the event. This value triggered the alert. | [optional] [readonly] +**Units** | Pointer to [**RawMetricUnits**](RawMetricUnits.md) | | [optional] [default to RAWMETRICUNITS_RAW] + +## Methods + +### NewRawMetricValue + +`func NewRawMetricValue() *RawMetricValue` + +NewRawMetricValue instantiates a new RawMetricValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRawMetricValueWithDefaults + +`func NewRawMetricValueWithDefaults() *RawMetricValue` + +NewRawMetricValueWithDefaults instantiates a new RawMetricValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *RawMetricValue) GetNumber() float64` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *RawMetricValue) GetNumberOk() (*float64, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *RawMetricValue) SetNumber(v float64)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *RawMetricValue) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetUnits + +`func (o *RawMetricValue) GetUnits() RawMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *RawMetricValue) GetUnitsOk() (*RawMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *RawMetricValue) SetUnits(v RawMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *RawMetricValue) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Refund.md b/docs/docs/Refund.md new file mode 100644 index 00000000..01cd6d17 --- /dev/null +++ b/docs/docs/Refund.md @@ -0,0 +1,134 @@ +# Refund + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AmountCents** | Pointer to **int64** | Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar). | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**PaymentId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the payment that the organization had made. | [optional] [readonly] +**Reason** | Pointer to **string** | Justification that MongoDB accepted to return funds to the organization. | [optional] [readonly] + +## Methods + +### NewRefund + +`func NewRefund() *Refund` + +NewRefund instantiates a new Refund object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRefundWithDefaults + +`func NewRefundWithDefaults() *Refund` + +NewRefundWithDefaults instantiates a new Refund object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAmountCents + +`func (o *Refund) GetAmountCents() int64` + +GetAmountCents returns the AmountCents field if non-nil, zero value otherwise. + +### GetAmountCentsOk + +`func (o *Refund) GetAmountCentsOk() (*int64, bool)` + +GetAmountCentsOk returns a tuple with the AmountCents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmountCents + +`func (o *Refund) SetAmountCents(v int64)` + +SetAmountCents sets AmountCents field to given value. + +### HasAmountCents + +`func (o *Refund) HasAmountCents() bool` + +HasAmountCents returns a boolean if a field has been set. + +### GetCreated + +`func (o *Refund) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Refund) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Refund) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Refund) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetPaymentId + +`func (o *Refund) GetPaymentId() string` + +GetPaymentId returns the PaymentId field if non-nil, zero value otherwise. + +### GetPaymentIdOk + +`func (o *Refund) GetPaymentIdOk() (*string, bool)` + +GetPaymentIdOk returns a tuple with the PaymentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPaymentId + +`func (o *Refund) SetPaymentId(v string)` + +SetPaymentId sets PaymentId field to given value. + +### HasPaymentId + +`func (o *Refund) HasPaymentId() bool` + +HasPaymentId returns a boolean if a field has been set. + +### GetReason + +`func (o *Refund) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *Refund) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *Refund) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *Refund) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RegionConfig.md b/docs/docs/RegionConfig.md new file mode 100644 index 00000000..921022d6 --- /dev/null +++ b/docs/docs/RegionConfig.md @@ -0,0 +1,264 @@ +# RegionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AnalyticsAutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**AnalyticsSpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**AutoScaling** | Pointer to [**AutoScalingV15**](AutoScalingV15.md) | | [optional] +**ReadOnlySpecs** | Pointer to [**DedicatedHardwareSpec**](DedicatedHardwareSpec.md) | | [optional] +**ElectableSpecs** | Pointer to [**HardwareSpec**](HardwareSpec.md) | | [optional] +**Priority** | Pointer to **int** | Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`. **Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively. | [optional] +**ProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`. | [optional] +**RegionName** | Pointer to **string** | Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. | [optional] +**BackingProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M2` or `M5`. | [optional] + +## Methods + +### NewRegionConfig + +`func NewRegionConfig() *RegionConfig` + +NewRegionConfig instantiates a new RegionConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRegionConfigWithDefaults + +`func NewRegionConfigWithDefaults() *RegionConfig` + +NewRegionConfigWithDefaults instantiates a new RegionConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAnalyticsAutoScaling + +`func (o *RegionConfig) GetAnalyticsAutoScaling() AutoScalingV15` + +GetAnalyticsAutoScaling returns the AnalyticsAutoScaling field if non-nil, zero value otherwise. + +### GetAnalyticsAutoScalingOk + +`func (o *RegionConfig) GetAnalyticsAutoScalingOk() (*AutoScalingV15, bool)` + +GetAnalyticsAutoScalingOk returns a tuple with the AnalyticsAutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsAutoScaling + +`func (o *RegionConfig) SetAnalyticsAutoScaling(v AutoScalingV15)` + +SetAnalyticsAutoScaling sets AnalyticsAutoScaling field to given value. + +### HasAnalyticsAutoScaling + +`func (o *RegionConfig) HasAnalyticsAutoScaling() bool` + +HasAnalyticsAutoScaling returns a boolean if a field has been set. + +### GetAnalyticsSpecs + +`func (o *RegionConfig) GetAnalyticsSpecs() DedicatedHardwareSpec` + +GetAnalyticsSpecs returns the AnalyticsSpecs field if non-nil, zero value otherwise. + +### GetAnalyticsSpecsOk + +`func (o *RegionConfig) GetAnalyticsSpecsOk() (*DedicatedHardwareSpec, bool)` + +GetAnalyticsSpecsOk returns a tuple with the AnalyticsSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsSpecs + +`func (o *RegionConfig) SetAnalyticsSpecs(v DedicatedHardwareSpec)` + +SetAnalyticsSpecs sets AnalyticsSpecs field to given value. + +### HasAnalyticsSpecs + +`func (o *RegionConfig) HasAnalyticsSpecs() bool` + +HasAnalyticsSpecs returns a boolean if a field has been set. + +### GetAutoScaling + +`func (o *RegionConfig) GetAutoScaling() AutoScalingV15` + +GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise. + +### GetAutoScalingOk + +`func (o *RegionConfig) GetAutoScalingOk() (*AutoScalingV15, bool)` + +GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoScaling + +`func (o *RegionConfig) SetAutoScaling(v AutoScalingV15)` + +SetAutoScaling sets AutoScaling field to given value. + +### HasAutoScaling + +`func (o *RegionConfig) HasAutoScaling() bool` + +HasAutoScaling returns a boolean if a field has been set. + +### GetReadOnlySpecs + +`func (o *RegionConfig) GetReadOnlySpecs() DedicatedHardwareSpec` + +GetReadOnlySpecs returns the ReadOnlySpecs field if non-nil, zero value otherwise. + +### GetReadOnlySpecsOk + +`func (o *RegionConfig) GetReadOnlySpecsOk() (*DedicatedHardwareSpec, bool)` + +GetReadOnlySpecsOk returns a tuple with the ReadOnlySpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadOnlySpecs + +`func (o *RegionConfig) SetReadOnlySpecs(v DedicatedHardwareSpec)` + +SetReadOnlySpecs sets ReadOnlySpecs field to given value. + +### HasReadOnlySpecs + +`func (o *RegionConfig) HasReadOnlySpecs() bool` + +HasReadOnlySpecs returns a boolean if a field has been set. + +### GetElectableSpecs + +`func (o *RegionConfig) GetElectableSpecs() HardwareSpec` + +GetElectableSpecs returns the ElectableSpecs field if non-nil, zero value otherwise. + +### GetElectableSpecsOk + +`func (o *RegionConfig) GetElectableSpecsOk() (*HardwareSpec, bool)` + +GetElectableSpecsOk returns a tuple with the ElectableSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElectableSpecs + +`func (o *RegionConfig) SetElectableSpecs(v HardwareSpec)` + +SetElectableSpecs sets ElectableSpecs field to given value. + +### HasElectableSpecs + +`func (o *RegionConfig) HasElectableSpecs() bool` + +HasElectableSpecs returns a boolean if a field has been set. + +### GetPriority + +`func (o *RegionConfig) GetPriority() int` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *RegionConfig) GetPriorityOk() (*int, bool)` + +GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPriority + +`func (o *RegionConfig) SetPriority(v int)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *RegionConfig) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetProviderName + +`func (o *RegionConfig) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *RegionConfig) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *RegionConfig) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *RegionConfig) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *RegionConfig) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *RegionConfig) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *RegionConfig) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *RegionConfig) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + +### GetBackingProviderName + +`func (o *RegionConfig) GetBackingProviderName() string` + +GetBackingProviderName returns the BackingProviderName field if non-nil, zero value otherwise. + +### GetBackingProviderNameOk + +`func (o *RegionConfig) GetBackingProviderNameOk() (*string, bool)` + +GetBackingProviderNameOk returns a tuple with the BackingProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackingProviderName + +`func (o *RegionConfig) SetBackingProviderName(v string)` + +SetBackingProviderName sets BackingProviderName field to given value. + +### HasBackingProviderName + +`func (o *RegionConfig) HasBackingProviderName() bool` + +HasBackingProviderName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RegionSpec.md b/docs/docs/RegionSpec.md new file mode 100644 index 00000000..2b35084b --- /dev/null +++ b/docs/docs/RegionSpec.md @@ -0,0 +1,134 @@ +# RegionSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AnalyticsNodes** | Pointer to **int** | Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead. | [optional] +**ElectableNodes** | Pointer to **int** | Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead. | [optional] +**Priority** | Pointer to **int** | Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`. | [optional] +**ReadOnlyNodes** | Pointer to **int** | Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead. | [optional] + +## Methods + +### NewRegionSpec + +`func NewRegionSpec() *RegionSpec` + +NewRegionSpec instantiates a new RegionSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRegionSpecWithDefaults + +`func NewRegionSpecWithDefaults() *RegionSpec` + +NewRegionSpecWithDefaults instantiates a new RegionSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAnalyticsNodes + +`func (o *RegionSpec) GetAnalyticsNodes() int` + +GetAnalyticsNodes returns the AnalyticsNodes field if non-nil, zero value otherwise. + +### GetAnalyticsNodesOk + +`func (o *RegionSpec) GetAnalyticsNodesOk() (*int, bool)` + +GetAnalyticsNodesOk returns a tuple with the AnalyticsNodes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnalyticsNodes + +`func (o *RegionSpec) SetAnalyticsNodes(v int)` + +SetAnalyticsNodes sets AnalyticsNodes field to given value. + +### HasAnalyticsNodes + +`func (o *RegionSpec) HasAnalyticsNodes() bool` + +HasAnalyticsNodes returns a boolean if a field has been set. + +### GetElectableNodes + +`func (o *RegionSpec) GetElectableNodes() int` + +GetElectableNodes returns the ElectableNodes field if non-nil, zero value otherwise. + +### GetElectableNodesOk + +`func (o *RegionSpec) GetElectableNodesOk() (*int, bool)` + +GetElectableNodesOk returns a tuple with the ElectableNodes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElectableNodes + +`func (o *RegionSpec) SetElectableNodes(v int)` + +SetElectableNodes sets ElectableNodes field to given value. + +### HasElectableNodes + +`func (o *RegionSpec) HasElectableNodes() bool` + +HasElectableNodes returns a boolean if a field has been set. + +### GetPriority + +`func (o *RegionSpec) GetPriority() int` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *RegionSpec) GetPriorityOk() (*int, bool)` + +GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPriority + +`func (o *RegionSpec) SetPriority(v int)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *RegionSpec) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetReadOnlyNodes + +`func (o *RegionSpec) GetReadOnlyNodes() int` + +GetReadOnlyNodes returns the ReadOnlyNodes field if non-nil, zero value otherwise. + +### GetReadOnlyNodesOk + +`func (o *RegionSpec) GetReadOnlyNodesOk() (*int, bool)` + +GetReadOnlyNodesOk returns a tuple with the ReadOnlyNodes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReadOnlyNodes + +`func (o *RegionSpec) SetReadOnlyNodes(v int)` + +SetReadOnlyNodes sets ReadOnlyNodes field to given value. + +### HasReadOnlyNodes + +`func (o *RegionSpec) HasReadOnlyNodes() bool` + +HasReadOnlyNodes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetAlertConfigViewForNdsGroup.md b/docs/docs/ReplicaSetAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..bda6519b --- /dev/null +++ b/docs/docs/ReplicaSetAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# ReplicaSetAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold**](ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]ReplicaSetMatcher**](ReplicaSetMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**ThresholdViewInteger**](ThresholdViewInteger.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewReplicaSetAlertConfigViewForNdsGroup + +`func NewReplicaSetAlertConfigViewForNdsGroup(eventTypeName ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold, ) *ReplicaSetAlertConfigViewForNdsGroup` + +NewReplicaSetAlertConfigViewForNdsGroup instantiates a new ReplicaSetAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReplicaSetAlertConfigViewForNdsGroupWithDefaults + +`func NewReplicaSetAlertConfigViewForNdsGroupWithDefaults() *ReplicaSetAlertConfigViewForNdsGroup` + +NewReplicaSetAlertConfigViewForNdsGroupWithDefaults instantiates a new ReplicaSetAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetEventTypeName() ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetEventTypeName(v ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetMatchers() []ReplicaSetMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetMatchersOk() (*[]ReplicaSetMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetMatchers(v []ReplicaSetMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetThreshold() ThresholdViewInteger` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetThresholdOk() (*ThresholdViewInteger, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetThreshold(v ThresholdViewInteger)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *ReplicaSetAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetAlertViewForNdsGroup.md b/docs/docs/ReplicaSetAlertViewForNdsGroup.md new file mode 100644 index 00000000..4a16b2f8 --- /dev/null +++ b/docs/docs/ReplicaSetAlertViewForNdsGroup.md @@ -0,0 +1,489 @@ +# ReplicaSetAlertViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**ReplicaSetEventTypeViewForNdsGroupAlertable**](ReplicaSetEventTypeViewForNdsGroupAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**NonRunningHostIds** | Pointer to **[]string** | | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**ParentClusterId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewReplicaSetAlertViewForNdsGroup + +`func NewReplicaSetAlertViewForNdsGroup(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName ReplicaSetEventTypeViewForNdsGroupAlertable, id string, status string, updated time.Time, ) *ReplicaSetAlertViewForNdsGroup` + +NewReplicaSetAlertViewForNdsGroup instantiates a new ReplicaSetAlertViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReplicaSetAlertViewForNdsGroupWithDefaults + +`func NewReplicaSetAlertViewForNdsGroupWithDefaults() *ReplicaSetAlertViewForNdsGroup` + +NewReplicaSetAlertViewForNdsGroupWithDefaults instantiates a new ReplicaSetAlertViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *ReplicaSetAlertViewForNdsGroup) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *ReplicaSetAlertViewForNdsGroup) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *ReplicaSetAlertViewForNdsGroup) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *ReplicaSetAlertViewForNdsGroup) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *ReplicaSetAlertViewForNdsGroup) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *ReplicaSetAlertViewForNdsGroup) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *ReplicaSetAlertViewForNdsGroup) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *ReplicaSetAlertViewForNdsGroup) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *ReplicaSetAlertViewForNdsGroup) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *ReplicaSetAlertViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReplicaSetAlertViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *ReplicaSetAlertViewForNdsGroup) GetEventTypeName() ReplicaSetEventTypeViewForNdsGroupAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetEventTypeNameOk() (*ReplicaSetEventTypeViewForNdsGroupAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ReplicaSetAlertViewForNdsGroup) SetEventTypeName(v ReplicaSetEventTypeViewForNdsGroupAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ReplicaSetAlertViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ReplicaSetAlertViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ReplicaSetAlertViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *ReplicaSetAlertViewForNdsGroup) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *ReplicaSetAlertViewForNdsGroup) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *ReplicaSetAlertViewForNdsGroup) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetId + +`func (o *ReplicaSetAlertViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReplicaSetAlertViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *ReplicaSetAlertViewForNdsGroup) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *ReplicaSetAlertViewForNdsGroup) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *ReplicaSetAlertViewForNdsGroup) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *ReplicaSetAlertViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ReplicaSetAlertViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ReplicaSetAlertViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetNonRunningHostIds + +`func (o *ReplicaSetAlertViewForNdsGroup) GetNonRunningHostIds() []string` + +GetNonRunningHostIds returns the NonRunningHostIds field if non-nil, zero value otherwise. + +### GetNonRunningHostIdsOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetNonRunningHostIdsOk() (*[]string, bool)` + +GetNonRunningHostIdsOk returns a tuple with the NonRunningHostIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonRunningHostIds + +`func (o *ReplicaSetAlertViewForNdsGroup) SetNonRunningHostIds(v []string)` + +SetNonRunningHostIds sets NonRunningHostIds field to given value. + +### HasNonRunningHostIds + +`func (o *ReplicaSetAlertViewForNdsGroup) HasNonRunningHostIds() bool` + +HasNonRunningHostIds returns a boolean if a field has been set. + +### GetOrgId + +`func (o *ReplicaSetAlertViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *ReplicaSetAlertViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *ReplicaSetAlertViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetParentClusterId + +`func (o *ReplicaSetAlertViewForNdsGroup) GetParentClusterId() string` + +GetParentClusterId returns the ParentClusterId field if non-nil, zero value otherwise. + +### GetParentClusterIdOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetParentClusterIdOk() (*string, bool)` + +GetParentClusterIdOk returns a tuple with the ParentClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentClusterId + +`func (o *ReplicaSetAlertViewForNdsGroup) SetParentClusterId(v string)` + +SetParentClusterId sets ParentClusterId field to given value. + +### HasParentClusterId + +`func (o *ReplicaSetAlertViewForNdsGroup) HasParentClusterId() bool` + +HasParentClusterId returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *ReplicaSetAlertViewForNdsGroup) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *ReplicaSetAlertViewForNdsGroup) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *ReplicaSetAlertViewForNdsGroup) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetResolved + +`func (o *ReplicaSetAlertViewForNdsGroup) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *ReplicaSetAlertViewForNdsGroup) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *ReplicaSetAlertViewForNdsGroup) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReplicaSetAlertViewForNdsGroup) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReplicaSetAlertViewForNdsGroup) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *ReplicaSetAlertViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *ReplicaSetAlertViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *ReplicaSetAlertViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetEventTypeViewForNdsGroup.md b/docs/docs/ReplicaSetEventTypeViewForNdsGroup.md new file mode 100644 index 00000000..af079256 --- /dev/null +++ b/docs/docs/ReplicaSetEventTypeViewForNdsGroup.md @@ -0,0 +1,21 @@ +# ReplicaSetEventTypeViewForNdsGroup + +## Enum + + +* `PRIMARY_ELECTED` (value: `"PRIMARY_ELECTED"`) + +* `REPLICATION_OPLOG_WINDOW_HEALTHY` (value: `"REPLICATION_OPLOG_WINDOW_HEALTHY"`) + +* `REPLICATION_OPLOG_WINDOW_RUNNING_OUT` (value: `"REPLICATION_OPLOG_WINDOW_RUNNING_OUT"`) + +* `ONE_PRIMARY` (value: `"ONE_PRIMARY"`) + +* `NO_PRIMARY` (value: `"NO_PRIMARY"`) + +* `TOO_MANY_ELECTIONS` (value: `"TOO_MANY_ELECTIONS"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertable.md b/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertable.md new file mode 100644 index 00000000..a241cc39 --- /dev/null +++ b/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertable.md @@ -0,0 +1,17 @@ +# ReplicaSetEventTypeViewForNdsGroupAlertable + +## Enum + + +* `REPLICATION_OPLOG_WINDOW_RUNNING_OUT` (value: `"REPLICATION_OPLOG_WINDOW_RUNNING_OUT"`) + +* `NO_PRIMARY` (value: `"NO_PRIMARY"`) + +* `PRIMARY_ELECTED` (value: `"PRIMARY_ELECTED"`) + +* `TOO_MANY_ELECTIONS` (value: `"TOO_MANY_ELECTIONS"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold.md b/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold.md new file mode 100644 index 00000000..eeacab27 --- /dev/null +++ b/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold.md @@ -0,0 +1,13 @@ +# ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold + +## Enum + + +* `NO_PRIMARY` (value: `"NO_PRIMARY"`) + +* `PRIMARY_ELECTED` (value: `"PRIMARY_ELECTED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold.md b/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold.md new file mode 100644 index 00000000..2285afa3 --- /dev/null +++ b/docs/docs/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold.md @@ -0,0 +1,13 @@ +# ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold + +## Enum + + +* `TOO_MANY_ELECTIONS` (value: `"TOO_MANY_ELECTIONS"`) + +* `REPLICATION_OPLOG_WINDOW_RUNNING_OUT` (value: `"REPLICATION_OPLOG_WINDOW_RUNNING_OUT"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetMatcher.md b/docs/docs/ReplicaSetMatcher.md new file mode 100644 index 00000000..2df89fe8 --- /dev/null +++ b/docs/docs/ReplicaSetMatcher.md @@ -0,0 +1,108 @@ +# ReplicaSetMatcher + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FieldName** | Pointer to [**ReplicaSetMatcherField**](ReplicaSetMatcherField.md) | | [optional] +**Operator** | Pointer to **string** | Comparison operator to apply when checking the current metric value against **matcher[n].value**. | [optional] +**Value** | Pointer to **string** | Value to match or exceed using the specified **matchers.operator**. | [optional] + +## Methods + +### NewReplicaSetMatcher + +`func NewReplicaSetMatcher() *ReplicaSetMatcher` + +NewReplicaSetMatcher instantiates a new ReplicaSetMatcher object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReplicaSetMatcherWithDefaults + +`func NewReplicaSetMatcherWithDefaults() *ReplicaSetMatcher` + +NewReplicaSetMatcherWithDefaults instantiates a new ReplicaSetMatcher object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFieldName + +`func (o *ReplicaSetMatcher) GetFieldName() ReplicaSetMatcherField` + +GetFieldName returns the FieldName field if non-nil, zero value otherwise. + +### GetFieldNameOk + +`func (o *ReplicaSetMatcher) GetFieldNameOk() (*ReplicaSetMatcherField, bool)` + +GetFieldNameOk returns a tuple with the FieldName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFieldName + +`func (o *ReplicaSetMatcher) SetFieldName(v ReplicaSetMatcherField)` + +SetFieldName sets FieldName field to given value. + +### HasFieldName + +`func (o *ReplicaSetMatcher) HasFieldName() bool` + +HasFieldName returns a boolean if a field has been set. + +### GetOperator + +`func (o *ReplicaSetMatcher) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ReplicaSetMatcher) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ReplicaSetMatcher) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ReplicaSetMatcher) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetValue + +`func (o *ReplicaSetMatcher) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ReplicaSetMatcher) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ReplicaSetMatcher) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ReplicaSetMatcher) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetMatcherField.md b/docs/docs/ReplicaSetMatcherField.md new file mode 100644 index 00000000..54589145 --- /dev/null +++ b/docs/docs/ReplicaSetMatcherField.md @@ -0,0 +1,15 @@ +# ReplicaSetMatcherField + +## Enum + + +* `REPLICA_SET_NAME` (value: `"REPLICA_SET_NAME"`) + +* `SHARD_NAME` (value: `"SHARD_NAME"`) + +* `CLUSTER_NAME` (value: `"CLUSTER_NAME"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicaSetThresholdAlertConfigViewForNdsGroup.md b/docs/docs/ReplicaSetThresholdAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..8c732bbc --- /dev/null +++ b/docs/docs/ReplicaSetThresholdAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# ReplicaSetThresholdAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold**](ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to [**[]ReplicaSetMatcher**](ReplicaSetMatcher.md) | List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster. | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Threshold** | Pointer to [**GreaterThanRawThreshold**](GreaterThanRawThreshold.md) | | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewReplicaSetThresholdAlertConfigViewForNdsGroup + +`func NewReplicaSetThresholdAlertConfigViewForNdsGroup(eventTypeName ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold, ) *ReplicaSetThresholdAlertConfigViewForNdsGroup` + +NewReplicaSetThresholdAlertConfigViewForNdsGroup instantiates a new ReplicaSetThresholdAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReplicaSetThresholdAlertConfigViewForNdsGroupWithDefaults + +`func NewReplicaSetThresholdAlertConfigViewForNdsGroupWithDefaults() *ReplicaSetThresholdAlertConfigViewForNdsGroup` + +NewReplicaSetThresholdAlertConfigViewForNdsGroupWithDefaults instantiates a new ReplicaSetThresholdAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetEventTypeName() ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetEventTypeName(v ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetMatchers() []ReplicaSetMatcher` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetMatchersOk() (*[]ReplicaSetMatcher, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetMatchers(v []ReplicaSetMatcher)` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetNotifications + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetThreshold + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetThreshold() GreaterThanRawThreshold` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetThresholdOk() (*GreaterThanRawThreshold, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetThreshold(v GreaterThanRawThreshold)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUpdated + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *ReplicaSetThresholdAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ReplicationSpec.md b/docs/docs/ReplicationSpec.md new file mode 100644 index 00000000..cb0b2493 --- /dev/null +++ b/docs/docs/ReplicationSpec.md @@ -0,0 +1,134 @@ +# ReplicationSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request. | [optional] [readonly] +**NumShards** | Pointer to **int** | Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations. | [optional] +**RegionConfigs** | Pointer to [**[]RegionConfig**](RegionConfig.md) | Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**. **Example:** If you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes. | [optional] +**ZoneName** | Pointer to **string** | Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`. | [optional] + +## Methods + +### NewReplicationSpec + +`func NewReplicationSpec() *ReplicationSpec` + +NewReplicationSpec instantiates a new ReplicationSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewReplicationSpecWithDefaults + +`func NewReplicationSpecWithDefaults() *ReplicationSpec` + +NewReplicationSpecWithDefaults instantiates a new ReplicationSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *ReplicationSpec) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReplicationSpec) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReplicationSpec) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReplicationSpec) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNumShards + +`func (o *ReplicationSpec) GetNumShards() int` + +GetNumShards returns the NumShards field if non-nil, zero value otherwise. + +### GetNumShardsOk + +`func (o *ReplicationSpec) GetNumShardsOk() (*int, bool)` + +GetNumShardsOk returns a tuple with the NumShards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumShards + +`func (o *ReplicationSpec) SetNumShards(v int)` + +SetNumShards sets NumShards field to given value. + +### HasNumShards + +`func (o *ReplicationSpec) HasNumShards() bool` + +HasNumShards returns a boolean if a field has been set. + +### GetRegionConfigs + +`func (o *ReplicationSpec) GetRegionConfigs() []RegionConfig` + +GetRegionConfigs returns the RegionConfigs field if non-nil, zero value otherwise. + +### GetRegionConfigsOk + +`func (o *ReplicationSpec) GetRegionConfigsOk() (*[]RegionConfig, bool)` + +GetRegionConfigsOk returns a tuple with the RegionConfigs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionConfigs + +`func (o *ReplicationSpec) SetRegionConfigs(v []RegionConfig)` + +SetRegionConfigs sets RegionConfigs field to given value. + +### HasRegionConfigs + +`func (o *ReplicationSpec) HasRegionConfigs() bool` + +HasRegionConfigs returns a boolean if a field has been set. + +### GetZoneName + +`func (o *ReplicationSpec) GetZoneName() string` + +GetZoneName returns the ZoneName field if non-nil, zero value otherwise. + +### GetZoneNameOk + +`func (o *ReplicationSpec) GetZoneNameOk() (*string, bool)` + +GetZoneNameOk returns a tuple with the ZoneName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetZoneName + +`func (o *ReplicationSpec) SetZoneName(v string)` + +SetZoneName sets ZoneName field to given value. + +### HasZoneName + +`func (o *ReplicationSpec) HasZoneName() bool` + +HasZoneName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RestoreJob.md b/docs/docs/RestoreJob.md new file mode 100644 index 00000000..3647f158 --- /dev/null +++ b/docs/docs/RestoreJob.md @@ -0,0 +1,493 @@ +# RestoreJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore. | [optional] [readonly] +**CheckpointId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only. - If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**. - If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object. | [optional] +**ClusterId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters. | [optional] [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster containing the snapshots you want to retrieve. | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Delivery** | [**RestoreJobDelivery**](RestoreJobDelivery.md) | | +**EncryptionEnabled** | Pointer to **bool** | Flag that indicates whether someone encrypted the data in the restored snapshot. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns the snapshots. | [optional] [readonly] +**Hashes** | Pointer to [**[]RestoreJobFileHash**](RestoreJobFileHash.md) | List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the restore job. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MasterKeyUUID** | Pointer to **string** | Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`. | [optional] [readonly] +**OplogInc** | Pointer to **int** | Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. - If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**. - If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object. | [optional] +**OplogTs** | Pointer to **string** | Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp. - If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**. - If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object. | [optional] +**PointInTimeUTCMillis** | Pointer to **int64** | Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. - If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object. - If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**. | [optional] +**SnapshotId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**. | [optional] +**StatusName** | Pointer to **string** | Human-readable label that identifies the status of the downloadable file at the time of the request. | [optional] [readonly] +**Timestamp** | Pointer to [**BSONTimestamp**](BSONTimestamp.md) | | [optional] + +## Methods + +### NewRestoreJob + +`func NewRestoreJob(delivery RestoreJobDelivery, ) *RestoreJob` + +NewRestoreJob instantiates a new RestoreJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRestoreJobWithDefaults + +`func NewRestoreJobWithDefaults() *RestoreJob` + +NewRestoreJobWithDefaults instantiates a new RestoreJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBatchId + +`func (o *RestoreJob) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *RestoreJob) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *RestoreJob) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *RestoreJob) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetCheckpointId + +`func (o *RestoreJob) GetCheckpointId() string` + +GetCheckpointId returns the CheckpointId field if non-nil, zero value otherwise. + +### GetCheckpointIdOk + +`func (o *RestoreJob) GetCheckpointIdOk() (*string, bool)` + +GetCheckpointIdOk returns a tuple with the CheckpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCheckpointId + +`func (o *RestoreJob) SetCheckpointId(v string)` + +SetCheckpointId sets CheckpointId field to given value. + +### HasCheckpointId + +`func (o *RestoreJob) HasCheckpointId() bool` + +HasCheckpointId returns a boolean if a field has been set. + +### GetClusterId + +`func (o *RestoreJob) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *RestoreJob) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *RestoreJob) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + +### HasClusterId + +`func (o *RestoreJob) HasClusterId() bool` + +HasClusterId returns a boolean if a field has been set. + +### GetClusterName + +`func (o *RestoreJob) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *RestoreJob) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *RestoreJob) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *RestoreJob) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *RestoreJob) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RestoreJob) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RestoreJob) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RestoreJob) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetDelivery + +`func (o *RestoreJob) GetDelivery() RestoreJobDelivery` + +GetDelivery returns the Delivery field if non-nil, zero value otherwise. + +### GetDeliveryOk + +`func (o *RestoreJob) GetDeliveryOk() (*RestoreJobDelivery, bool)` + +GetDeliveryOk returns a tuple with the Delivery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelivery + +`func (o *RestoreJob) SetDelivery(v RestoreJobDelivery)` + +SetDelivery sets Delivery field to given value. + + +### GetEncryptionEnabled + +`func (o *RestoreJob) GetEncryptionEnabled() bool` + +GetEncryptionEnabled returns the EncryptionEnabled field if non-nil, zero value otherwise. + +### GetEncryptionEnabledOk + +`func (o *RestoreJob) GetEncryptionEnabledOk() (*bool, bool)` + +GetEncryptionEnabledOk returns a tuple with the EncryptionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionEnabled + +`func (o *RestoreJob) SetEncryptionEnabled(v bool)` + +SetEncryptionEnabled sets EncryptionEnabled field to given value. + +### HasEncryptionEnabled + +`func (o *RestoreJob) HasEncryptionEnabled() bool` + +HasEncryptionEnabled returns a boolean if a field has been set. + +### GetGroupId + +`func (o *RestoreJob) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *RestoreJob) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *RestoreJob) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *RestoreJob) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHashes + +`func (o *RestoreJob) GetHashes() []RestoreJobFileHash` + +GetHashes returns the Hashes field if non-nil, zero value otherwise. + +### GetHashesOk + +`func (o *RestoreJob) GetHashesOk() (*[]RestoreJobFileHash, bool)` + +GetHashesOk returns a tuple with the Hashes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHashes + +`func (o *RestoreJob) SetHashes(v []RestoreJobFileHash)` + +SetHashes sets Hashes field to given value. + +### HasHashes + +`func (o *RestoreJob) HasHashes() bool` + +HasHashes returns a boolean if a field has been set. + +### GetId + +`func (o *RestoreJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RestoreJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RestoreJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RestoreJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *RestoreJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *RestoreJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *RestoreJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *RestoreJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMasterKeyUUID + +`func (o *RestoreJob) GetMasterKeyUUID() string` + +GetMasterKeyUUID returns the MasterKeyUUID field if non-nil, zero value otherwise. + +### GetMasterKeyUUIDOk + +`func (o *RestoreJob) GetMasterKeyUUIDOk() (*string, bool)` + +GetMasterKeyUUIDOk returns a tuple with the MasterKeyUUID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMasterKeyUUID + +`func (o *RestoreJob) SetMasterKeyUUID(v string)` + +SetMasterKeyUUID sets MasterKeyUUID field to given value. + +### HasMasterKeyUUID + +`func (o *RestoreJob) HasMasterKeyUUID() bool` + +HasMasterKeyUUID returns a boolean if a field has been set. + +### GetOplogInc + +`func (o *RestoreJob) GetOplogInc() int` + +GetOplogInc returns the OplogInc field if non-nil, zero value otherwise. + +### GetOplogIncOk + +`func (o *RestoreJob) GetOplogIncOk() (*int, bool)` + +GetOplogIncOk returns a tuple with the OplogInc field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogInc + +`func (o *RestoreJob) SetOplogInc(v int)` + +SetOplogInc sets OplogInc field to given value. + +### HasOplogInc + +`func (o *RestoreJob) HasOplogInc() bool` + +HasOplogInc returns a boolean if a field has been set. + +### GetOplogTs + +`func (o *RestoreJob) GetOplogTs() string` + +GetOplogTs returns the OplogTs field if non-nil, zero value otherwise. + +### GetOplogTsOk + +`func (o *RestoreJob) GetOplogTsOk() (*string, bool)` + +GetOplogTsOk returns a tuple with the OplogTs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogTs + +`func (o *RestoreJob) SetOplogTs(v string)` + +SetOplogTs sets OplogTs field to given value. + +### HasOplogTs + +`func (o *RestoreJob) HasOplogTs() bool` + +HasOplogTs returns a boolean if a field has been set. + +### GetPointInTimeUTCMillis + +`func (o *RestoreJob) GetPointInTimeUTCMillis() int64` + +GetPointInTimeUTCMillis returns the PointInTimeUTCMillis field if non-nil, zero value otherwise. + +### GetPointInTimeUTCMillisOk + +`func (o *RestoreJob) GetPointInTimeUTCMillisOk() (*int64, bool)` + +GetPointInTimeUTCMillisOk returns a tuple with the PointInTimeUTCMillis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPointInTimeUTCMillis + +`func (o *RestoreJob) SetPointInTimeUTCMillis(v int64)` + +SetPointInTimeUTCMillis sets PointInTimeUTCMillis field to given value. + +### HasPointInTimeUTCMillis + +`func (o *RestoreJob) HasPointInTimeUTCMillis() bool` + +HasPointInTimeUTCMillis returns a boolean if a field has been set. + +### GetSnapshotId + +`func (o *RestoreJob) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *RestoreJob) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *RestoreJob) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + +### HasSnapshotId + +`func (o *RestoreJob) HasSnapshotId() bool` + +HasSnapshotId returns a boolean if a field has been set. + +### GetStatusName + +`func (o *RestoreJob) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *RestoreJob) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *RestoreJob) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *RestoreJob) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *RestoreJob) GetTimestamp() BSONTimestamp` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *RestoreJob) GetTimestampOk() (*BSONTimestamp, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *RestoreJob) SetTimestamp(v BSONTimestamp)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *RestoreJob) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RestoreJobDelivery.md b/docs/docs/RestoreJobDelivery.md new file mode 100644 index 00000000..75bf3e2b --- /dev/null +++ b/docs/docs/RestoreJobDelivery.md @@ -0,0 +1,337 @@ +# RestoreJobDelivery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthHeader** | Pointer to **string** | Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`. | [optional] [readonly] +**AuthValue** | Pointer to **string** | Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`. | [optional] [readonly] +**ExpirationHours** | Pointer to **int** | Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`. | [optional] +**Expires** | Pointer to **time.Time** | Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`. | [optional] [readonly] +**MaxDownloads** | Pointer to **int** | Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`. | [optional] +**MethodName** | **string** | Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host. | +**StatusName** | Pointer to **string** | State of the downloadable snapshot file when MongoDB Cloud received this request. | [optional] [readonly] +**TargetClusterId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. If the target cluster doesn't have backup enabled, two resources return parameters with empty values: - **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements - **Get a Snapshot** endpoint doesn't return a **clusterId** parameter. To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. | [optional] +**TargetClusterName** | Pointer to **string** | Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. If the target cluster doesn't have backup enabled, two resources return parameters with empty values: - **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements - **Get a Snapshot** endpoint doesn't return a **clusterId** parameter. To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. | [optional] +**TargetGroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. | [optional] +**Url** | Pointer to **string** | Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`. | [optional] [readonly] +**UrlV2** | Pointer to **string** | Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`. | [optional] [readonly] + +## Methods + +### NewRestoreJobDelivery + +`func NewRestoreJobDelivery(methodName string, ) *RestoreJobDelivery` + +NewRestoreJobDelivery instantiates a new RestoreJobDelivery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRestoreJobDeliveryWithDefaults + +`func NewRestoreJobDeliveryWithDefaults() *RestoreJobDelivery` + +NewRestoreJobDeliveryWithDefaults instantiates a new RestoreJobDelivery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAuthHeader + +`func (o *RestoreJobDelivery) GetAuthHeader() string` + +GetAuthHeader returns the AuthHeader field if non-nil, zero value otherwise. + +### GetAuthHeaderOk + +`func (o *RestoreJobDelivery) GetAuthHeaderOk() (*string, bool)` + +GetAuthHeaderOk returns a tuple with the AuthHeader field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthHeader + +`func (o *RestoreJobDelivery) SetAuthHeader(v string)` + +SetAuthHeader sets AuthHeader field to given value. + +### HasAuthHeader + +`func (o *RestoreJobDelivery) HasAuthHeader() bool` + +HasAuthHeader returns a boolean if a field has been set. + +### GetAuthValue + +`func (o *RestoreJobDelivery) GetAuthValue() string` + +GetAuthValue returns the AuthValue field if non-nil, zero value otherwise. + +### GetAuthValueOk + +`func (o *RestoreJobDelivery) GetAuthValueOk() (*string, bool)` + +GetAuthValueOk returns a tuple with the AuthValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthValue + +`func (o *RestoreJobDelivery) SetAuthValue(v string)` + +SetAuthValue sets AuthValue field to given value. + +### HasAuthValue + +`func (o *RestoreJobDelivery) HasAuthValue() bool` + +HasAuthValue returns a boolean if a field has been set. + +### GetExpirationHours + +`func (o *RestoreJobDelivery) GetExpirationHours() int` + +GetExpirationHours returns the ExpirationHours field if non-nil, zero value otherwise. + +### GetExpirationHoursOk + +`func (o *RestoreJobDelivery) GetExpirationHoursOk() (*int, bool)` + +GetExpirationHoursOk returns a tuple with the ExpirationHours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpirationHours + +`func (o *RestoreJobDelivery) SetExpirationHours(v int)` + +SetExpirationHours sets ExpirationHours field to given value. + +### HasExpirationHours + +`func (o *RestoreJobDelivery) HasExpirationHours() bool` + +HasExpirationHours returns a boolean if a field has been set. + +### GetExpires + +`func (o *RestoreJobDelivery) GetExpires() time.Time` + +GetExpires returns the Expires field if non-nil, zero value otherwise. + +### GetExpiresOk + +`func (o *RestoreJobDelivery) GetExpiresOk() (*time.Time, bool)` + +GetExpiresOk returns a tuple with the Expires field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpires + +`func (o *RestoreJobDelivery) SetExpires(v time.Time)` + +SetExpires sets Expires field to given value. + +### HasExpires + +`func (o *RestoreJobDelivery) HasExpires() bool` + +HasExpires returns a boolean if a field has been set. + +### GetMaxDownloads + +`func (o *RestoreJobDelivery) GetMaxDownloads() int` + +GetMaxDownloads returns the MaxDownloads field if non-nil, zero value otherwise. + +### GetMaxDownloadsOk + +`func (o *RestoreJobDelivery) GetMaxDownloadsOk() (*int, bool)` + +GetMaxDownloadsOk returns a tuple with the MaxDownloads field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxDownloads + +`func (o *RestoreJobDelivery) SetMaxDownloads(v int)` + +SetMaxDownloads sets MaxDownloads field to given value. + +### HasMaxDownloads + +`func (o *RestoreJobDelivery) HasMaxDownloads() bool` + +HasMaxDownloads returns a boolean if a field has been set. + +### GetMethodName + +`func (o *RestoreJobDelivery) GetMethodName() string` + +GetMethodName returns the MethodName field if non-nil, zero value otherwise. + +### GetMethodNameOk + +`func (o *RestoreJobDelivery) GetMethodNameOk() (*string, bool)` + +GetMethodNameOk returns a tuple with the MethodName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethodName + +`func (o *RestoreJobDelivery) SetMethodName(v string)` + +SetMethodName sets MethodName field to given value. + + +### GetStatusName + +`func (o *RestoreJobDelivery) GetStatusName() string` + +GetStatusName returns the StatusName field if non-nil, zero value otherwise. + +### GetStatusNameOk + +`func (o *RestoreJobDelivery) GetStatusNameOk() (*string, bool)` + +GetStatusNameOk returns a tuple with the StatusName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusName + +`func (o *RestoreJobDelivery) SetStatusName(v string)` + +SetStatusName sets StatusName field to given value. + +### HasStatusName + +`func (o *RestoreJobDelivery) HasStatusName() bool` + +HasStatusName returns a boolean if a field has been set. + +### GetTargetClusterId + +`func (o *RestoreJobDelivery) GetTargetClusterId() string` + +GetTargetClusterId returns the TargetClusterId field if non-nil, zero value otherwise. + +### GetTargetClusterIdOk + +`func (o *RestoreJobDelivery) GetTargetClusterIdOk() (*string, bool)` + +GetTargetClusterIdOk returns a tuple with the TargetClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetClusterId + +`func (o *RestoreJobDelivery) SetTargetClusterId(v string)` + +SetTargetClusterId sets TargetClusterId field to given value. + +### HasTargetClusterId + +`func (o *RestoreJobDelivery) HasTargetClusterId() bool` + +HasTargetClusterId returns a boolean if a field has been set. + +### GetTargetClusterName + +`func (o *RestoreJobDelivery) GetTargetClusterName() string` + +GetTargetClusterName returns the TargetClusterName field if non-nil, zero value otherwise. + +### GetTargetClusterNameOk + +`func (o *RestoreJobDelivery) GetTargetClusterNameOk() (*string, bool)` + +GetTargetClusterNameOk returns a tuple with the TargetClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetClusterName + +`func (o *RestoreJobDelivery) SetTargetClusterName(v string)` + +SetTargetClusterName sets TargetClusterName field to given value. + +### HasTargetClusterName + +`func (o *RestoreJobDelivery) HasTargetClusterName() bool` + +HasTargetClusterName returns a boolean if a field has been set. + +### GetTargetGroupId + +`func (o *RestoreJobDelivery) GetTargetGroupId() string` + +GetTargetGroupId returns the TargetGroupId field if non-nil, zero value otherwise. + +### GetTargetGroupIdOk + +`func (o *RestoreJobDelivery) GetTargetGroupIdOk() (*string, bool)` + +GetTargetGroupIdOk returns a tuple with the TargetGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetGroupId + +`func (o *RestoreJobDelivery) SetTargetGroupId(v string)` + +SetTargetGroupId sets TargetGroupId field to given value. + +### HasTargetGroupId + +`func (o *RestoreJobDelivery) HasTargetGroupId() bool` + +HasTargetGroupId returns a boolean if a field has been set. + +### GetUrl + +`func (o *RestoreJobDelivery) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *RestoreJobDelivery) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *RestoreJobDelivery) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *RestoreJobDelivery) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + +### GetUrlV2 + +`func (o *RestoreJobDelivery) GetUrlV2() string` + +GetUrlV2 returns the UrlV2 field if non-nil, zero value otherwise. + +### GetUrlV2Ok + +`func (o *RestoreJobDelivery) GetUrlV2Ok() (*string, bool)` + +GetUrlV2Ok returns a tuple with the UrlV2 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrlV2 + +`func (o *RestoreJobDelivery) SetUrlV2(v string)` + +SetUrlV2 sets UrlV2 field to given value. + +### HasUrlV2 + +`func (o *RestoreJobDelivery) HasUrlV2() bool` + +HasUrlV2 returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RestoreJobFileHash.md b/docs/docs/RestoreJobFileHash.md new file mode 100644 index 00000000..69106bc4 --- /dev/null +++ b/docs/docs/RestoreJobFileHash.md @@ -0,0 +1,134 @@ +# RestoreJobFileHash + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FileName** | Pointer to **string** | Human-readable label that identifies the hashed file. | [optional] [readonly] +**Hash** | Pointer to **string** | Hashed checksum that maps to the restore file. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**TypeName** | Pointer to **string** | Human-readable label that identifies the hashing algorithm used to compute the hash value. | [optional] [readonly] + +## Methods + +### NewRestoreJobFileHash + +`func NewRestoreJobFileHash() *RestoreJobFileHash` + +NewRestoreJobFileHash instantiates a new RestoreJobFileHash object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRestoreJobFileHashWithDefaults + +`func NewRestoreJobFileHashWithDefaults() *RestoreJobFileHash` + +NewRestoreJobFileHashWithDefaults instantiates a new RestoreJobFileHash object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFileName + +`func (o *RestoreJobFileHash) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *RestoreJobFileHash) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *RestoreJobFileHash) SetFileName(v string)` + +SetFileName sets FileName field to given value. + +### HasFileName + +`func (o *RestoreJobFileHash) HasFileName() bool` + +HasFileName returns a boolean if a field has been set. + +### GetHash + +`func (o *RestoreJobFileHash) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *RestoreJobFileHash) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *RestoreJobFileHash) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *RestoreJobFileHash) HasHash() bool` + +HasHash returns a boolean if a field has been set. + +### GetLinks + +`func (o *RestoreJobFileHash) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *RestoreJobFileHash) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *RestoreJobFileHash) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *RestoreJobFileHash) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetTypeName + +`func (o *RestoreJobFileHash) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *RestoreJobFileHash) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *RestoreJobFileHash) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + +### HasTypeName + +`func (o *RestoreJobFileHash) HasTypeName() bool` + +HasTypeName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Role.md b/docs/docs/Role.md new file mode 100644 index 00000000..9451ed21 --- /dev/null +++ b/docs/docs/Role.md @@ -0,0 +1,93 @@ +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CollectionName** | **string** | Collection on which this role applies. | +**DatabaseName** | **string** | Database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. | +**RoleName** | **string** | Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role. | + +## Methods + +### NewRole + +`func NewRole(collectionName string, databaseName string, roleName string, ) *Role` + +NewRole instantiates a new Role object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRoleWithDefaults + +`func NewRoleWithDefaults() *Role` + +NewRoleWithDefaults instantiates a new Role object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCollectionName + +`func (o *Role) GetCollectionName() string` + +GetCollectionName returns the CollectionName field if non-nil, zero value otherwise. + +### GetCollectionNameOk + +`func (o *Role) GetCollectionNameOk() (*string, bool)` + +GetCollectionNameOk returns a tuple with the CollectionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollectionName + +`func (o *Role) SetCollectionName(v string)` + +SetCollectionName sets CollectionName field to given value. + + +### GetDatabaseName + +`func (o *Role) GetDatabaseName() string` + +GetDatabaseName returns the DatabaseName field if non-nil, zero value otherwise. + +### GetDatabaseNameOk + +`func (o *Role) GetDatabaseNameOk() (*string, bool)` + +GetDatabaseNameOk returns a tuple with the DatabaseName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatabaseName + +`func (o *Role) SetDatabaseName(v string)` + +SetDatabaseName sets DatabaseName field to given value. + + +### GetRoleName + +`func (o *Role) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *Role) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *Role) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RoleAssignment.md b/docs/docs/RoleAssignment.md new file mode 100644 index 00000000..8d6c455f --- /dev/null +++ b/docs/docs/RoleAssignment.md @@ -0,0 +1,108 @@ +# RoleAssignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request. | [optional] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request. | [optional] +**Role** | Pointer to **string** | Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles. Organization Roles * ORG_OWNER * ORG_MEMBER * ORG_GROUP_CREATOR * ORG_BILLING_ADMIN * ORG_READ_ONLY Project Roles * GROUP_CLUSTER_MANAGER * GROUP_DATA_ACCESS_ADMIN * GROUP_DATA_ACCESS_READ_ONLY * GROUP_DATA_ACCESS_READ_WRITE * GROUP_OWNER * GROUP_READ_ONLY * GROUP_SEARCH_INDEX_EDITOR | [optional] + +## Methods + +### NewRoleAssignment + +`func NewRoleAssignment() *RoleAssignment` + +NewRoleAssignment instantiates a new RoleAssignment object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRoleAssignmentWithDefaults + +`func NewRoleAssignmentWithDefaults() *RoleAssignment` + +NewRoleAssignmentWithDefaults instantiates a new RoleAssignment object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetGroupId + +`func (o *RoleAssignment) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *RoleAssignment) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *RoleAssignment) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *RoleAssignment) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetOrgId + +`func (o *RoleAssignment) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *RoleAssignment) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *RoleAssignment) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *RoleAssignment) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetRole + +`func (o *RoleAssignment) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleAssignment) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleAssignment) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleAssignment) HasRole() bool` + +HasRole returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RoleMapping.md b/docs/docs/RoleMapping.md new file mode 100644 index 00000000..adade3d1 --- /dev/null +++ b/docs/docs/RoleMapping.md @@ -0,0 +1,103 @@ +# RoleMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalGroupName** | **string** | Unique human-readable label that identifies the identity provider group to whichthis role mapping applies. | +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this role mapping. | [optional] [readonly] +**RoleAssignments** | Pointer to [**[]RoleAssignment**](RoleAssignment.md) | Atlas roles and the unique identifiers of the groups and organizations associated with each role. | [optional] + +## Methods + +### NewRoleMapping + +`func NewRoleMapping(externalGroupName string, ) *RoleMapping` + +NewRoleMapping instantiates a new RoleMapping object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRoleMappingWithDefaults + +`func NewRoleMappingWithDefaults() *RoleMapping` + +NewRoleMappingWithDefaults instantiates a new RoleMapping object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetExternalGroupName + +`func (o *RoleMapping) GetExternalGroupName() string` + +GetExternalGroupName returns the ExternalGroupName field if non-nil, zero value otherwise. + +### GetExternalGroupNameOk + +`func (o *RoleMapping) GetExternalGroupNameOk() (*string, bool)` + +GetExternalGroupNameOk returns a tuple with the ExternalGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalGroupName + +`func (o *RoleMapping) SetExternalGroupName(v string)` + +SetExternalGroupName sets ExternalGroupName field to given value. + + +### GetId + +`func (o *RoleMapping) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMapping) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMapping) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMapping) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRoleAssignments + +`func (o *RoleMapping) GetRoleAssignments() []RoleAssignment` + +GetRoleAssignments returns the RoleAssignments field if non-nil, zero value otherwise. + +### GetRoleAssignmentsOk + +`func (o *RoleMapping) GetRoleAssignmentsOk() (*[]RoleAssignment, bool)` + +GetRoleAssignmentsOk returns a tuple with the RoleAssignments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleAssignments + +`func (o *RoleMapping) SetRoleAssignments(v []RoleAssignment)` + +SetRoleAssignments sets RoleAssignments field to given value. + +### HasRoleAssignments + +`func (o *RoleMapping) HasRoleAssignments() bool` + +HasRoleAssignments returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/RollingIndexApi.md b/docs/docs/RollingIndexApi.md new file mode 100644 index 00000000..259747ed --- /dev/null +++ b/docs/docs/RollingIndexApi.md @@ -0,0 +1,86 @@ +# \RollingIndexApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateRollingIndex**](RollingIndexApi.md#CreateRollingIndex) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index | Create One Rolling Index + + + +## CreateRollingIndex + +> CreateRollingIndex(ctx, groupId, clusterName).IndexRequest(indexRequest).Execute() + +Create One Rolling Index + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + indexRequest := *openapiclient.NewIndexRequest("Collection_example", "Db_example") // IndexRequest | + + r, err := sdk.RollingIndexApi.CreateRollingIndex(context.Background(), groupId, clusterName).IndexRequest(indexRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RollingIndexApi.CreateRollingIndex``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster on which MongoDB Cloud creates an index. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRollingIndexRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **indexRequest** | [**IndexRequest**](IndexRequest.md) | Rolling index to create on the specified cluster. | + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/RootApi.md b/docs/docs/RootApi.md new file mode 100644 index 00000000..33373ce2 --- /dev/null +++ b/docs/docs/RootApi.md @@ -0,0 +1,74 @@ +# \RootApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetSystemStatus**](RootApi.md#GetSystemStatus) | **Get** /api/atlas/v2 | Return the status of this MongoDB application + + + +## GetSystemStatus + +> SystemStatus GetSystemStatus(ctx).Execute() + +Return the status of this MongoDB application + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + + resp, r, err := sdk.RootApi.GetSystemStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RootApi.GetSystemStatus``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetSystemStatus`: SystemStatus + fmt.Fprintf(os.Stdout, "Response from `RootApi.GetSystemStatus`: %v\n", resp) +} +``` + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSystemStatusRequest struct via the builder pattern + + +### Return type + +[**SystemStatus**](SystemStatus.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/SMSNotification.md b/docs/docs/SMSNotification.md new file mode 100644 index 00000000..6476ae3c --- /dev/null +++ b/docs/docs/SMSNotification.md @@ -0,0 +1,129 @@ +# SMSNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**MobileNumber** | Pointer to **string** | Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewSMSNotification + +`func NewSMSNotification(typeName string, ) *SMSNotification` + +NewSMSNotification instantiates a new SMSNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSMSNotificationWithDefaults + +`func NewSMSNotificationWithDefaults() *SMSNotification` + +NewSMSNotificationWithDefaults instantiates a new SMSNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *SMSNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *SMSNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *SMSNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *SMSNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *SMSNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *SMSNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *SMSNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *SMSNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetMobileNumber + +`func (o *SMSNotification) GetMobileNumber() string` + +GetMobileNumber returns the MobileNumber field if non-nil, zero value otherwise. + +### GetMobileNumberOk + +`func (o *SMSNotification) GetMobileNumberOk() (*string, bool)` + +GetMobileNumberOk returns a tuple with the MobileNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMobileNumber + +`func (o *SMSNotification) SetMobileNumber(v string)` + +SetMobileNumber sets MobileNumber field to given value. + +### HasMobileNumber + +`func (o *SMSNotification) HasMobileNumber() bool` + +HasMobileNumber returns a boolean if a field has been set. + +### GetTypeName + +`func (o *SMSNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *SMSNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *SMSNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SampleDatasetStatus.md b/docs/docs/SampleDatasetStatus.md new file mode 100644 index 00000000..2f50c4b5 --- /dev/null +++ b/docs/docs/SampleDatasetStatus.md @@ -0,0 +1,186 @@ +# SampleDatasetStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies this sample dataset. | [optional] [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster into which you loaded the sample dataset. | [optional] [readonly] +**CompleteDate** | Pointer to **time.Time** | Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**CreateDate** | Pointer to **time.Time** | Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED. | [optional] [readonly] +**State** | Pointer to **string** | Status of the sample dataset load job. | [optional] [readonly] + +## Methods + +### NewSampleDatasetStatus + +`func NewSampleDatasetStatus() *SampleDatasetStatus` + +NewSampleDatasetStatus instantiates a new SampleDatasetStatus object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSampleDatasetStatusWithDefaults + +`func NewSampleDatasetStatusWithDefaults() *SampleDatasetStatus` + +NewSampleDatasetStatusWithDefaults instantiates a new SampleDatasetStatus object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *SampleDatasetStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SampleDatasetStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SampleDatasetStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SampleDatasetStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetClusterName + +`func (o *SampleDatasetStatus) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *SampleDatasetStatus) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *SampleDatasetStatus) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *SampleDatasetStatus) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCompleteDate + +`func (o *SampleDatasetStatus) GetCompleteDate() time.Time` + +GetCompleteDate returns the CompleteDate field if non-nil, zero value otherwise. + +### GetCompleteDateOk + +`func (o *SampleDatasetStatus) GetCompleteDateOk() (*time.Time, bool)` + +GetCompleteDateOk returns a tuple with the CompleteDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleteDate + +`func (o *SampleDatasetStatus) SetCompleteDate(v time.Time)` + +SetCompleteDate sets CompleteDate field to given value. + +### HasCompleteDate + +`func (o *SampleDatasetStatus) HasCompleteDate() bool` + +HasCompleteDate returns a boolean if a field has been set. + +### GetCreateDate + +`func (o *SampleDatasetStatus) GetCreateDate() time.Time` + +GetCreateDate returns the CreateDate field if non-nil, zero value otherwise. + +### GetCreateDateOk + +`func (o *SampleDatasetStatus) GetCreateDateOk() (*time.Time, bool)` + +GetCreateDateOk returns a tuple with the CreateDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreateDate + +`func (o *SampleDatasetStatus) SetCreateDate(v time.Time)` + +SetCreateDate sets CreateDate field to given value. + +### HasCreateDate + +`func (o *SampleDatasetStatus) HasCreateDate() bool` + +HasCreateDate returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *SampleDatasetStatus) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *SampleDatasetStatus) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *SampleDatasetStatus) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *SampleDatasetStatus) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetState + +`func (o *SampleDatasetStatus) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SampleDatasetStatus) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SampleDatasetStatus) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SampleDatasetStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessAWSTenantEndpoint.md b/docs/docs/ServerlessAWSTenantEndpoint.md new file mode 100644 index 00000000..311a274b --- /dev/null +++ b/docs/docs/ServerlessAWSTenantEndpoint.md @@ -0,0 +1,212 @@ +# ServerlessAWSTenantEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the private endpoint. | [optional] [readonly] +**CloudProviderEndpointId** | Pointer to **string** | Unique string that identifies the private endpoint's network interface. | [optional] [readonly] +**Comment** | Pointer to **string** | Human-readable comment associated with the private endpoint. | [optional] [readonly] +**EndpointServiceName** | Pointer to **string** | Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Human-readable error message that indicates error condition associated with establishing the private endpoint connection. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Human-readable label that identifies the cloud service provider. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable label that indicates the current operating status of the private endpoint. | [optional] [readonly] + +## Methods + +### NewServerlessAWSTenantEndpoint + +`func NewServerlessAWSTenantEndpoint() *ServerlessAWSTenantEndpoint` + +NewServerlessAWSTenantEndpoint instantiates a new ServerlessAWSTenantEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessAWSTenantEndpointWithDefaults + +`func NewServerlessAWSTenantEndpointWithDefaults() *ServerlessAWSTenantEndpoint` + +NewServerlessAWSTenantEndpointWithDefaults instantiates a new ServerlessAWSTenantEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *ServerlessAWSTenantEndpoint) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServerlessAWSTenantEndpoint) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServerlessAWSTenantEndpoint) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServerlessAWSTenantEndpoint) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudProviderEndpointId + +`func (o *ServerlessAWSTenantEndpoint) GetCloudProviderEndpointId() string` + +GetCloudProviderEndpointId returns the CloudProviderEndpointId field if non-nil, zero value otherwise. + +### GetCloudProviderEndpointIdOk + +`func (o *ServerlessAWSTenantEndpoint) GetCloudProviderEndpointIdOk() (*string, bool)` + +GetCloudProviderEndpointIdOk returns a tuple with the CloudProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProviderEndpointId + +`func (o *ServerlessAWSTenantEndpoint) SetCloudProviderEndpointId(v string)` + +SetCloudProviderEndpointId sets CloudProviderEndpointId field to given value. + +### HasCloudProviderEndpointId + +`func (o *ServerlessAWSTenantEndpoint) HasCloudProviderEndpointId() bool` + +HasCloudProviderEndpointId returns a boolean if a field has been set. + +### GetComment + +`func (o *ServerlessAWSTenantEndpoint) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ServerlessAWSTenantEndpoint) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ServerlessAWSTenantEndpoint) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ServerlessAWSTenantEndpoint) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetEndpointServiceName + +`func (o *ServerlessAWSTenantEndpoint) GetEndpointServiceName() string` + +GetEndpointServiceName returns the EndpointServiceName field if non-nil, zero value otherwise. + +### GetEndpointServiceNameOk + +`func (o *ServerlessAWSTenantEndpoint) GetEndpointServiceNameOk() (*string, bool)` + +GetEndpointServiceNameOk returns a tuple with the EndpointServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointServiceName + +`func (o *ServerlessAWSTenantEndpoint) SetEndpointServiceName(v string)` + +SetEndpointServiceName sets EndpointServiceName field to given value. + +### HasEndpointServiceName + +`func (o *ServerlessAWSTenantEndpoint) HasEndpointServiceName() bool` + +HasEndpointServiceName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ServerlessAWSTenantEndpoint) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ServerlessAWSTenantEndpoint) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ServerlessAWSTenantEndpoint) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ServerlessAWSTenantEndpoint) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ServerlessAWSTenantEndpoint) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessAWSTenantEndpoint) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessAWSTenantEndpoint) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *ServerlessAWSTenantEndpoint) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ServerlessAWSTenantEndpoint) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ServerlessAWSTenantEndpoint) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ServerlessAWSTenantEndpoint) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ServerlessAWSTenantEndpoint) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessAWSTenantEndpointUpdate.md b/docs/docs/ServerlessAWSTenantEndpointUpdate.md new file mode 100644 index 00000000..df159b4e --- /dev/null +++ b/docs/docs/ServerlessAWSTenantEndpointUpdate.md @@ -0,0 +1,103 @@ +# ServerlessAWSTenantEndpointUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProviderEndpointId** | Pointer to **string** | Unique string that identifies the private endpoint's network interface. | [optional] +**Comment** | Pointer to **string** | Human-readable comment associated with the private endpoint. | [optional] +**ProviderName** | **string** | | + +## Methods + +### NewServerlessAWSTenantEndpointUpdate + +`func NewServerlessAWSTenantEndpointUpdate(providerName string, ) *ServerlessAWSTenantEndpointUpdate` + +NewServerlessAWSTenantEndpointUpdate instantiates a new ServerlessAWSTenantEndpointUpdate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessAWSTenantEndpointUpdateWithDefaults + +`func NewServerlessAWSTenantEndpointUpdateWithDefaults() *ServerlessAWSTenantEndpointUpdate` + +NewServerlessAWSTenantEndpointUpdateWithDefaults instantiates a new ServerlessAWSTenantEndpointUpdate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProviderEndpointId + +`func (o *ServerlessAWSTenantEndpointUpdate) GetCloudProviderEndpointId() string` + +GetCloudProviderEndpointId returns the CloudProviderEndpointId field if non-nil, zero value otherwise. + +### GetCloudProviderEndpointIdOk + +`func (o *ServerlessAWSTenantEndpointUpdate) GetCloudProviderEndpointIdOk() (*string, bool)` + +GetCloudProviderEndpointIdOk returns a tuple with the CloudProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProviderEndpointId + +`func (o *ServerlessAWSTenantEndpointUpdate) SetCloudProviderEndpointId(v string)` + +SetCloudProviderEndpointId sets CloudProviderEndpointId field to given value. + +### HasCloudProviderEndpointId + +`func (o *ServerlessAWSTenantEndpointUpdate) HasCloudProviderEndpointId() bool` + +HasCloudProviderEndpointId returns a boolean if a field has been set. + +### GetComment + +`func (o *ServerlessAWSTenantEndpointUpdate) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ServerlessAWSTenantEndpointUpdate) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ServerlessAWSTenantEndpointUpdate) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ServerlessAWSTenantEndpointUpdate) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ServerlessAWSTenantEndpointUpdate) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessAWSTenantEndpointUpdate) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessAWSTenantEndpointUpdate) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessAzureTenantEndpoint.md b/docs/docs/ServerlessAzureTenantEndpoint.md new file mode 100644 index 00000000..c6d8849c --- /dev/null +++ b/docs/docs/ServerlessAzureTenantEndpoint.md @@ -0,0 +1,264 @@ +# ServerlessAzureTenantEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the private endpoint. | [optional] [readonly] +**CloudProviderEndpointId** | Pointer to **string** | Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service. | [optional] [readonly] +**Comment** | Pointer to **string** | Human-readable comment associated with the private endpoint. | [optional] [readonly] +**EndpointServiceName** | Pointer to **string** | Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Human-readable error message that indicates error condition associated with establishing the private endpoint connection. | [optional] [readonly] +**PrivateEndpointIpAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] [readonly] +**PrivateLinkServiceResourceId** | Pointer to **string** | Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Human-readable label that identifies the cloud service provider. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable label that indicates the current operating status of the private endpoint. | [optional] [readonly] + +## Methods + +### NewServerlessAzureTenantEndpoint + +`func NewServerlessAzureTenantEndpoint() *ServerlessAzureTenantEndpoint` + +NewServerlessAzureTenantEndpoint instantiates a new ServerlessAzureTenantEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessAzureTenantEndpointWithDefaults + +`func NewServerlessAzureTenantEndpointWithDefaults() *ServerlessAzureTenantEndpoint` + +NewServerlessAzureTenantEndpointWithDefaults instantiates a new ServerlessAzureTenantEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *ServerlessAzureTenantEndpoint) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServerlessAzureTenantEndpoint) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServerlessAzureTenantEndpoint) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServerlessAzureTenantEndpoint) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudProviderEndpointId + +`func (o *ServerlessAzureTenantEndpoint) GetCloudProviderEndpointId() string` + +GetCloudProviderEndpointId returns the CloudProviderEndpointId field if non-nil, zero value otherwise. + +### GetCloudProviderEndpointIdOk + +`func (o *ServerlessAzureTenantEndpoint) GetCloudProviderEndpointIdOk() (*string, bool)` + +GetCloudProviderEndpointIdOk returns a tuple with the CloudProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProviderEndpointId + +`func (o *ServerlessAzureTenantEndpoint) SetCloudProviderEndpointId(v string)` + +SetCloudProviderEndpointId sets CloudProviderEndpointId field to given value. + +### HasCloudProviderEndpointId + +`func (o *ServerlessAzureTenantEndpoint) HasCloudProviderEndpointId() bool` + +HasCloudProviderEndpointId returns a boolean if a field has been set. + +### GetComment + +`func (o *ServerlessAzureTenantEndpoint) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ServerlessAzureTenantEndpoint) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ServerlessAzureTenantEndpoint) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ServerlessAzureTenantEndpoint) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetEndpointServiceName + +`func (o *ServerlessAzureTenantEndpoint) GetEndpointServiceName() string` + +GetEndpointServiceName returns the EndpointServiceName field if non-nil, zero value otherwise. + +### GetEndpointServiceNameOk + +`func (o *ServerlessAzureTenantEndpoint) GetEndpointServiceNameOk() (*string, bool)` + +GetEndpointServiceNameOk returns a tuple with the EndpointServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointServiceName + +`func (o *ServerlessAzureTenantEndpoint) SetEndpointServiceName(v string)` + +SetEndpointServiceName sets EndpointServiceName field to given value. + +### HasEndpointServiceName + +`func (o *ServerlessAzureTenantEndpoint) HasEndpointServiceName() bool` + +HasEndpointServiceName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ServerlessAzureTenantEndpoint) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ServerlessAzureTenantEndpoint) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ServerlessAzureTenantEndpoint) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ServerlessAzureTenantEndpoint) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetPrivateEndpointIpAddress + +`func (o *ServerlessAzureTenantEndpoint) GetPrivateEndpointIpAddress() string` + +GetPrivateEndpointIpAddress returns the PrivateEndpointIpAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIpAddressOk + +`func (o *ServerlessAzureTenantEndpoint) GetPrivateEndpointIpAddressOk() (*string, bool)` + +GetPrivateEndpointIpAddressOk returns a tuple with the PrivateEndpointIpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIpAddress + +`func (o *ServerlessAzureTenantEndpoint) SetPrivateEndpointIpAddress(v string)` + +SetPrivateEndpointIpAddress sets PrivateEndpointIpAddress field to given value. + +### HasPrivateEndpointIpAddress + +`func (o *ServerlessAzureTenantEndpoint) HasPrivateEndpointIpAddress() bool` + +HasPrivateEndpointIpAddress returns a boolean if a field has been set. + +### GetPrivateLinkServiceResourceId + +`func (o *ServerlessAzureTenantEndpoint) GetPrivateLinkServiceResourceId() string` + +GetPrivateLinkServiceResourceId returns the PrivateLinkServiceResourceId field if non-nil, zero value otherwise. + +### GetPrivateLinkServiceResourceIdOk + +`func (o *ServerlessAzureTenantEndpoint) GetPrivateLinkServiceResourceIdOk() (*string, bool)` + +GetPrivateLinkServiceResourceIdOk returns a tuple with the PrivateLinkServiceResourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateLinkServiceResourceId + +`func (o *ServerlessAzureTenantEndpoint) SetPrivateLinkServiceResourceId(v string)` + +SetPrivateLinkServiceResourceId sets PrivateLinkServiceResourceId field to given value. + +### HasPrivateLinkServiceResourceId + +`func (o *ServerlessAzureTenantEndpoint) HasPrivateLinkServiceResourceId() bool` + +HasPrivateLinkServiceResourceId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ServerlessAzureTenantEndpoint) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessAzureTenantEndpoint) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessAzureTenantEndpoint) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *ServerlessAzureTenantEndpoint) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ServerlessAzureTenantEndpoint) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ServerlessAzureTenantEndpoint) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ServerlessAzureTenantEndpoint) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ServerlessAzureTenantEndpoint) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessAzureTenantEndpointUpdate.md b/docs/docs/ServerlessAzureTenantEndpointUpdate.md new file mode 100644 index 00000000..304d8f58 --- /dev/null +++ b/docs/docs/ServerlessAzureTenantEndpointUpdate.md @@ -0,0 +1,129 @@ +# ServerlessAzureTenantEndpointUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProviderEndpointId** | Pointer to **string** | Unique string that identifies the Azure private endpoint's network interface for this private endpoint service. | [optional] +**PrivateEndpointIpAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] +**Comment** | Pointer to **string** | Human-readable comment associated with the private endpoint. | [optional] +**ProviderName** | **string** | | + +## Methods + +### NewServerlessAzureTenantEndpointUpdate + +`func NewServerlessAzureTenantEndpointUpdate(providerName string, ) *ServerlessAzureTenantEndpointUpdate` + +NewServerlessAzureTenantEndpointUpdate instantiates a new ServerlessAzureTenantEndpointUpdate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessAzureTenantEndpointUpdateWithDefaults + +`func NewServerlessAzureTenantEndpointUpdateWithDefaults() *ServerlessAzureTenantEndpointUpdate` + +NewServerlessAzureTenantEndpointUpdateWithDefaults instantiates a new ServerlessAzureTenantEndpointUpdate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProviderEndpointId + +`func (o *ServerlessAzureTenantEndpointUpdate) GetCloudProviderEndpointId() string` + +GetCloudProviderEndpointId returns the CloudProviderEndpointId field if non-nil, zero value otherwise. + +### GetCloudProviderEndpointIdOk + +`func (o *ServerlessAzureTenantEndpointUpdate) GetCloudProviderEndpointIdOk() (*string, bool)` + +GetCloudProviderEndpointIdOk returns a tuple with the CloudProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProviderEndpointId + +`func (o *ServerlessAzureTenantEndpointUpdate) SetCloudProviderEndpointId(v string)` + +SetCloudProviderEndpointId sets CloudProviderEndpointId field to given value. + +### HasCloudProviderEndpointId + +`func (o *ServerlessAzureTenantEndpointUpdate) HasCloudProviderEndpointId() bool` + +HasCloudProviderEndpointId returns a boolean if a field has been set. + +### GetPrivateEndpointIpAddress + +`func (o *ServerlessAzureTenantEndpointUpdate) GetPrivateEndpointIpAddress() string` + +GetPrivateEndpointIpAddress returns the PrivateEndpointIpAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIpAddressOk + +`func (o *ServerlessAzureTenantEndpointUpdate) GetPrivateEndpointIpAddressOk() (*string, bool)` + +GetPrivateEndpointIpAddressOk returns a tuple with the PrivateEndpointIpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIpAddress + +`func (o *ServerlessAzureTenantEndpointUpdate) SetPrivateEndpointIpAddress(v string)` + +SetPrivateEndpointIpAddress sets PrivateEndpointIpAddress field to given value. + +### HasPrivateEndpointIpAddress + +`func (o *ServerlessAzureTenantEndpointUpdate) HasPrivateEndpointIpAddress() bool` + +HasPrivateEndpointIpAddress returns a boolean if a field has been set. + +### GetComment + +`func (o *ServerlessAzureTenantEndpointUpdate) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ServerlessAzureTenantEndpointUpdate) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ServerlessAzureTenantEndpointUpdate) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ServerlessAzureTenantEndpointUpdate) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ServerlessAzureTenantEndpointUpdate) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessAzureTenantEndpointUpdate) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessAzureTenantEndpointUpdate) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessBackupOptions.md b/docs/docs/ServerlessBackupOptions.md new file mode 100644 index 00000000..69472f83 --- /dev/null +++ b/docs/docs/ServerlessBackupOptions.md @@ -0,0 +1,56 @@ +# ServerlessBackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ServerlessContinuousBackupEnabled** | Pointer to **bool** | Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**. If this parameter is `false`, the serverless instance uses **Basic Backup**. | Option | Description | |---|---| | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). | | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. | | [optional] [default to true] + +## Methods + +### NewServerlessBackupOptions + +`func NewServerlessBackupOptions() *ServerlessBackupOptions` + +NewServerlessBackupOptions instantiates a new ServerlessBackupOptions object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessBackupOptionsWithDefaults + +`func NewServerlessBackupOptionsWithDefaults() *ServerlessBackupOptions` + +NewServerlessBackupOptionsWithDefaults instantiates a new ServerlessBackupOptions object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetServerlessContinuousBackupEnabled + +`func (o *ServerlessBackupOptions) GetServerlessContinuousBackupEnabled() bool` + +GetServerlessContinuousBackupEnabled returns the ServerlessContinuousBackupEnabled field if non-nil, zero value otherwise. + +### GetServerlessContinuousBackupEnabledOk + +`func (o *ServerlessBackupOptions) GetServerlessContinuousBackupEnabledOk() (*bool, bool)` + +GetServerlessContinuousBackupEnabledOk returns a tuple with the ServerlessContinuousBackupEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerlessContinuousBackupEnabled + +`func (o *ServerlessBackupOptions) SetServerlessContinuousBackupEnabled(v bool)` + +SetServerlessContinuousBackupEnabled sets ServerlessContinuousBackupEnabled field to given value. + +### HasServerlessContinuousBackupEnabled + +`func (o *ServerlessBackupOptions) HasServerlessContinuousBackupEnabled() bool` + +HasServerlessContinuousBackupEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessBackupRestoreJob.md b/docs/docs/ServerlessBackupRestoreJob.md new file mode 100644 index 00000000..ef36faff --- /dev/null +++ b/docs/docs/ServerlessBackupRestoreJob.md @@ -0,0 +1,457 @@ +# ServerlessBackupRestoreJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Cancelled** | Pointer to **bool** | Flag that indicates whether someone canceled this restore job. | [optional] [readonly] +**DeliveryType** | **string** | Human-readable label that categorizes the restore job to create. | +**DeliveryUrl** | Pointer to **[]string** | One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`. | [optional] [readonly] +**DesiredTimestamp** | Pointer to [**BSONTimestamp**](BSONTimestamp.md) | | [optional] +**Expired** | Pointer to **bool** | Flag that indicates whether the restore job expired. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Failed** | Pointer to **bool** | Flag that indicates whether the restore job failed. | [optional] [readonly] +**FinishedAt** | Pointer to **time.Time** | Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the restore job. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OplogInc** | Pointer to **int** | Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`. | [optional] +**OplogTs** | Pointer to **int** | Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`. | [optional] +**PointInTimeUTCSeconds** | Pointer to **int** | Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`. | [optional] +**SnapshotId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the snapshot. | [optional] +**TargetClusterName** | **string** | Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. | +**TargetGroupId** | **string** | Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. | +**Timestamp** | Pointer to **time.Time** | Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewServerlessBackupRestoreJob + +`func NewServerlessBackupRestoreJob(deliveryType string, targetClusterName string, targetGroupId string, ) *ServerlessBackupRestoreJob` + +NewServerlessBackupRestoreJob instantiates a new ServerlessBackupRestoreJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessBackupRestoreJobWithDefaults + +`func NewServerlessBackupRestoreJobWithDefaults() *ServerlessBackupRestoreJob` + +NewServerlessBackupRestoreJobWithDefaults instantiates a new ServerlessBackupRestoreJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCancelled + +`func (o *ServerlessBackupRestoreJob) GetCancelled() bool` + +GetCancelled returns the Cancelled field if non-nil, zero value otherwise. + +### GetCancelledOk + +`func (o *ServerlessBackupRestoreJob) GetCancelledOk() (*bool, bool)` + +GetCancelledOk returns a tuple with the Cancelled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelled + +`func (o *ServerlessBackupRestoreJob) SetCancelled(v bool)` + +SetCancelled sets Cancelled field to given value. + +### HasCancelled + +`func (o *ServerlessBackupRestoreJob) HasCancelled() bool` + +HasCancelled returns a boolean if a field has been set. + +### GetDeliveryType + +`func (o *ServerlessBackupRestoreJob) GetDeliveryType() string` + +GetDeliveryType returns the DeliveryType field if non-nil, zero value otherwise. + +### GetDeliveryTypeOk + +`func (o *ServerlessBackupRestoreJob) GetDeliveryTypeOk() (*string, bool)` + +GetDeliveryTypeOk returns a tuple with the DeliveryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryType + +`func (o *ServerlessBackupRestoreJob) SetDeliveryType(v string)` + +SetDeliveryType sets DeliveryType field to given value. + + +### GetDeliveryUrl + +`func (o *ServerlessBackupRestoreJob) GetDeliveryUrl() []string` + +GetDeliveryUrl returns the DeliveryUrl field if non-nil, zero value otherwise. + +### GetDeliveryUrlOk + +`func (o *ServerlessBackupRestoreJob) GetDeliveryUrlOk() (*[]string, bool)` + +GetDeliveryUrlOk returns a tuple with the DeliveryUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryUrl + +`func (o *ServerlessBackupRestoreJob) SetDeliveryUrl(v []string)` + +SetDeliveryUrl sets DeliveryUrl field to given value. + +### HasDeliveryUrl + +`func (o *ServerlessBackupRestoreJob) HasDeliveryUrl() bool` + +HasDeliveryUrl returns a boolean if a field has been set. + +### GetDesiredTimestamp + +`func (o *ServerlessBackupRestoreJob) GetDesiredTimestamp() BSONTimestamp` + +GetDesiredTimestamp returns the DesiredTimestamp field if non-nil, zero value otherwise. + +### GetDesiredTimestampOk + +`func (o *ServerlessBackupRestoreJob) GetDesiredTimestampOk() (*BSONTimestamp, bool)` + +GetDesiredTimestampOk returns a tuple with the DesiredTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDesiredTimestamp + +`func (o *ServerlessBackupRestoreJob) SetDesiredTimestamp(v BSONTimestamp)` + +SetDesiredTimestamp sets DesiredTimestamp field to given value. + +### HasDesiredTimestamp + +`func (o *ServerlessBackupRestoreJob) HasDesiredTimestamp() bool` + +HasDesiredTimestamp returns a boolean if a field has been set. + +### GetExpired + +`func (o *ServerlessBackupRestoreJob) GetExpired() bool` + +GetExpired returns the Expired field if non-nil, zero value otherwise. + +### GetExpiredOk + +`func (o *ServerlessBackupRestoreJob) GetExpiredOk() (*bool, bool)` + +GetExpiredOk returns a tuple with the Expired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpired + +`func (o *ServerlessBackupRestoreJob) SetExpired(v bool)` + +SetExpired sets Expired field to given value. + +### HasExpired + +`func (o *ServerlessBackupRestoreJob) HasExpired() bool` + +HasExpired returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *ServerlessBackupRestoreJob) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *ServerlessBackupRestoreJob) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *ServerlessBackupRestoreJob) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *ServerlessBackupRestoreJob) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetFailed + +`func (o *ServerlessBackupRestoreJob) GetFailed() bool` + +GetFailed returns the Failed field if non-nil, zero value otherwise. + +### GetFailedOk + +`func (o *ServerlessBackupRestoreJob) GetFailedOk() (*bool, bool)` + +GetFailedOk returns a tuple with the Failed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailed + +`func (o *ServerlessBackupRestoreJob) SetFailed(v bool)` + +SetFailed sets Failed field to given value. + +### HasFailed + +`func (o *ServerlessBackupRestoreJob) HasFailed() bool` + +HasFailed returns a boolean if a field has been set. + +### GetFinishedAt + +`func (o *ServerlessBackupRestoreJob) GetFinishedAt() time.Time` + +GetFinishedAt returns the FinishedAt field if non-nil, zero value otherwise. + +### GetFinishedAtOk + +`func (o *ServerlessBackupRestoreJob) GetFinishedAtOk() (*time.Time, bool)` + +GetFinishedAtOk returns a tuple with the FinishedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinishedAt + +`func (o *ServerlessBackupRestoreJob) SetFinishedAt(v time.Time)` + +SetFinishedAt sets FinishedAt field to given value. + +### HasFinishedAt + +`func (o *ServerlessBackupRestoreJob) HasFinishedAt() bool` + +HasFinishedAt returns a boolean if a field has been set. + +### GetId + +`func (o *ServerlessBackupRestoreJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServerlessBackupRestoreJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServerlessBackupRestoreJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServerlessBackupRestoreJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ServerlessBackupRestoreJob) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ServerlessBackupRestoreJob) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ServerlessBackupRestoreJob) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ServerlessBackupRestoreJob) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOplogInc + +`func (o *ServerlessBackupRestoreJob) GetOplogInc() int` + +GetOplogInc returns the OplogInc field if non-nil, zero value otherwise. + +### GetOplogIncOk + +`func (o *ServerlessBackupRestoreJob) GetOplogIncOk() (*int, bool)` + +GetOplogIncOk returns a tuple with the OplogInc field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogInc + +`func (o *ServerlessBackupRestoreJob) SetOplogInc(v int)` + +SetOplogInc sets OplogInc field to given value. + +### HasOplogInc + +`func (o *ServerlessBackupRestoreJob) HasOplogInc() bool` + +HasOplogInc returns a boolean if a field has been set. + +### GetOplogTs + +`func (o *ServerlessBackupRestoreJob) GetOplogTs() int` + +GetOplogTs returns the OplogTs field if non-nil, zero value otherwise. + +### GetOplogTsOk + +`func (o *ServerlessBackupRestoreJob) GetOplogTsOk() (*int, bool)` + +GetOplogTsOk returns a tuple with the OplogTs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOplogTs + +`func (o *ServerlessBackupRestoreJob) SetOplogTs(v int)` + +SetOplogTs sets OplogTs field to given value. + +### HasOplogTs + +`func (o *ServerlessBackupRestoreJob) HasOplogTs() bool` + +HasOplogTs returns a boolean if a field has been set. + +### GetPointInTimeUTCSeconds + +`func (o *ServerlessBackupRestoreJob) GetPointInTimeUTCSeconds() int` + +GetPointInTimeUTCSeconds returns the PointInTimeUTCSeconds field if non-nil, zero value otherwise. + +### GetPointInTimeUTCSecondsOk + +`func (o *ServerlessBackupRestoreJob) GetPointInTimeUTCSecondsOk() (*int, bool)` + +GetPointInTimeUTCSecondsOk returns a tuple with the PointInTimeUTCSeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPointInTimeUTCSeconds + +`func (o *ServerlessBackupRestoreJob) SetPointInTimeUTCSeconds(v int)` + +SetPointInTimeUTCSeconds sets PointInTimeUTCSeconds field to given value. + +### HasPointInTimeUTCSeconds + +`func (o *ServerlessBackupRestoreJob) HasPointInTimeUTCSeconds() bool` + +HasPointInTimeUTCSeconds returns a boolean if a field has been set. + +### GetSnapshotId + +`func (o *ServerlessBackupRestoreJob) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *ServerlessBackupRestoreJob) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *ServerlessBackupRestoreJob) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + +### HasSnapshotId + +`func (o *ServerlessBackupRestoreJob) HasSnapshotId() bool` + +HasSnapshotId returns a boolean if a field has been set. + +### GetTargetClusterName + +`func (o *ServerlessBackupRestoreJob) GetTargetClusterName() string` + +GetTargetClusterName returns the TargetClusterName field if non-nil, zero value otherwise. + +### GetTargetClusterNameOk + +`func (o *ServerlessBackupRestoreJob) GetTargetClusterNameOk() (*string, bool)` + +GetTargetClusterNameOk returns a tuple with the TargetClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetClusterName + +`func (o *ServerlessBackupRestoreJob) SetTargetClusterName(v string)` + +SetTargetClusterName sets TargetClusterName field to given value. + + +### GetTargetGroupId + +`func (o *ServerlessBackupRestoreJob) GetTargetGroupId() string` + +GetTargetGroupId returns the TargetGroupId field if non-nil, zero value otherwise. + +### GetTargetGroupIdOk + +`func (o *ServerlessBackupRestoreJob) GetTargetGroupIdOk() (*string, bool)` + +GetTargetGroupIdOk returns a tuple with the TargetGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetGroupId + +`func (o *ServerlessBackupRestoreJob) SetTargetGroupId(v string)` + +SetTargetGroupId sets TargetGroupId field to given value. + + +### GetTimestamp + +`func (o *ServerlessBackupRestoreJob) GetTimestamp() time.Time` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ServerlessBackupRestoreJob) GetTimestampOk() (*time.Time, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ServerlessBackupRestoreJob) SetTimestamp(v time.Time)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *ServerlessBackupRestoreJob) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessBackupSnapshot.md b/docs/docs/ServerlessBackupSnapshot.md new file mode 100644 index 00000000..a4797689 --- /dev/null +++ b/docs/docs/ServerlessBackupSnapshot.md @@ -0,0 +1,290 @@ +# ServerlessBackupSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**ExpiresAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FrequencyType** | Pointer to **string** | Human-readable label that identifies how often this snapshot triggers. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the snapshot. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MongodVersion** | Pointer to **string** | Version of the MongoDB host that this snapshot backs up. | [optional] [readonly] +**ServerlessInstanceName** | Pointer to **string** | Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot. | [optional] [readonly] +**SnapshotType** | Pointer to **string** | Human-readable label that identifies when this snapshot triggers. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable label that indicates the stage of the backup process for this snapshot. | [optional] [readonly] +**StorageSizeBytes** | Pointer to **int64** | Number of bytes taken to store the backup snapshot. | [optional] [readonly] + +## Methods + +### NewServerlessBackupSnapshot + +`func NewServerlessBackupSnapshot() *ServerlessBackupSnapshot` + +NewServerlessBackupSnapshot instantiates a new ServerlessBackupSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessBackupSnapshotWithDefaults + +`func NewServerlessBackupSnapshotWithDefaults() *ServerlessBackupSnapshot` + +NewServerlessBackupSnapshotWithDefaults instantiates a new ServerlessBackupSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreatedAt + +`func (o *ServerlessBackupSnapshot) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ServerlessBackupSnapshot) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ServerlessBackupSnapshot) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ServerlessBackupSnapshot) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetExpiresAt + +`func (o *ServerlessBackupSnapshot) GetExpiresAt() time.Time` + +GetExpiresAt returns the ExpiresAt field if non-nil, zero value otherwise. + +### GetExpiresAtOk + +`func (o *ServerlessBackupSnapshot) GetExpiresAtOk() (*time.Time, bool)` + +GetExpiresAtOk returns a tuple with the ExpiresAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiresAt + +`func (o *ServerlessBackupSnapshot) SetExpiresAt(v time.Time)` + +SetExpiresAt sets ExpiresAt field to given value. + +### HasExpiresAt + +`func (o *ServerlessBackupSnapshot) HasExpiresAt() bool` + +HasExpiresAt returns a boolean if a field has been set. + +### GetFrequencyType + +`func (o *ServerlessBackupSnapshot) GetFrequencyType() string` + +GetFrequencyType returns the FrequencyType field if non-nil, zero value otherwise. + +### GetFrequencyTypeOk + +`func (o *ServerlessBackupSnapshot) GetFrequencyTypeOk() (*string, bool)` + +GetFrequencyTypeOk returns a tuple with the FrequencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequencyType + +`func (o *ServerlessBackupSnapshot) SetFrequencyType(v string)` + +SetFrequencyType sets FrequencyType field to given value. + +### HasFrequencyType + +`func (o *ServerlessBackupSnapshot) HasFrequencyType() bool` + +HasFrequencyType returns a boolean if a field has been set. + +### GetId + +`func (o *ServerlessBackupSnapshot) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServerlessBackupSnapshot) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServerlessBackupSnapshot) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServerlessBackupSnapshot) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ServerlessBackupSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ServerlessBackupSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ServerlessBackupSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ServerlessBackupSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMongodVersion + +`func (o *ServerlessBackupSnapshot) GetMongodVersion() string` + +GetMongodVersion returns the MongodVersion field if non-nil, zero value otherwise. + +### GetMongodVersionOk + +`func (o *ServerlessBackupSnapshot) GetMongodVersionOk() (*string, bool)` + +GetMongodVersionOk returns a tuple with the MongodVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongodVersion + +`func (o *ServerlessBackupSnapshot) SetMongodVersion(v string)` + +SetMongodVersion sets MongodVersion field to given value. + +### HasMongodVersion + +`func (o *ServerlessBackupSnapshot) HasMongodVersion() bool` + +HasMongodVersion returns a boolean if a field has been set. + +### GetServerlessInstanceName + +`func (o *ServerlessBackupSnapshot) GetServerlessInstanceName() string` + +GetServerlessInstanceName returns the ServerlessInstanceName field if non-nil, zero value otherwise. + +### GetServerlessInstanceNameOk + +`func (o *ServerlessBackupSnapshot) GetServerlessInstanceNameOk() (*string, bool)` + +GetServerlessInstanceNameOk returns a tuple with the ServerlessInstanceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerlessInstanceName + +`func (o *ServerlessBackupSnapshot) SetServerlessInstanceName(v string)` + +SetServerlessInstanceName sets ServerlessInstanceName field to given value. + +### HasServerlessInstanceName + +`func (o *ServerlessBackupSnapshot) HasServerlessInstanceName() bool` + +HasServerlessInstanceName returns a boolean if a field has been set. + +### GetSnapshotType + +`func (o *ServerlessBackupSnapshot) GetSnapshotType() string` + +GetSnapshotType returns the SnapshotType field if non-nil, zero value otherwise. + +### GetSnapshotTypeOk + +`func (o *ServerlessBackupSnapshot) GetSnapshotTypeOk() (*string, bool)` + +GetSnapshotTypeOk returns a tuple with the SnapshotType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotType + +`func (o *ServerlessBackupSnapshot) SetSnapshotType(v string)` + +SetSnapshotType sets SnapshotType field to given value. + +### HasSnapshotType + +`func (o *ServerlessBackupSnapshot) HasSnapshotType() bool` + +HasSnapshotType returns a boolean if a field has been set. + +### GetStatus + +`func (o *ServerlessBackupSnapshot) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ServerlessBackupSnapshot) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ServerlessBackupSnapshot) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ServerlessBackupSnapshot) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStorageSizeBytes + +`func (o *ServerlessBackupSnapshot) GetStorageSizeBytes() int64` + +GetStorageSizeBytes returns the StorageSizeBytes field if non-nil, zero value otherwise. + +### GetStorageSizeBytesOk + +`func (o *ServerlessBackupSnapshot) GetStorageSizeBytesOk() (*int64, bool)` + +GetStorageSizeBytesOk returns a tuple with the StorageSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageSizeBytes + +`func (o *ServerlessBackupSnapshot) SetStorageSizeBytes(v int64)` + +SetStorageSizeBytes sets StorageSizeBytes field to given value. + +### HasStorageSizeBytes + +`func (o *ServerlessBackupSnapshot) HasStorageSizeBytes() bool` + +HasStorageSizeBytes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessEventTypeViewAlertable.md b/docs/docs/ServerlessEventTypeViewAlertable.md new file mode 100644 index 00000000..bd6413c9 --- /dev/null +++ b/docs/docs/ServerlessEventTypeViewAlertable.md @@ -0,0 +1,11 @@ +# ServerlessEventTypeViewAlertable + +## Enum + + +* `OUTSIDE_SERVERLESS_METRIC_THRESHOLD` (value: `"OUTSIDE_SERVERLESS_METRIC_THRESHOLD"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessInstanceDescription.md b/docs/docs/ServerlessInstanceDescription.md new file mode 100644 index 00000000..b69a813e --- /dev/null +++ b/docs/docs/ServerlessInstanceDescription.md @@ -0,0 +1,311 @@ +# ServerlessInstanceDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectionStrings** | Pointer to [**ServerlessInstanceDescriptionConnectionStrings**](ServerlessInstanceDescriptionConnectionStrings.md) | | [optional] +**CreateDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the serverless instance. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MongoDBVersion** | Pointer to **string** | Version of MongoDB that the serverless instance runs. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the serverless instance. | [optional] [readonly] +**ProviderSettings** | [**ServerlessProviderSettings**](ServerlessProviderSettings.md) | | +**ServerlessBackupOptions** | Pointer to [**ServerlessBackupOptions**](ServerlessBackupOptions.md) | | [optional] +**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of the serverless instance. | [optional] [readonly] +**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance. | [optional] [default to false] + +## Methods + +### NewServerlessInstanceDescription + +`func NewServerlessInstanceDescription(providerSettings ServerlessProviderSettings, ) *ServerlessInstanceDescription` + +NewServerlessInstanceDescription instantiates a new ServerlessInstanceDescription object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessInstanceDescriptionWithDefaults + +`func NewServerlessInstanceDescriptionWithDefaults() *ServerlessInstanceDescription` + +NewServerlessInstanceDescriptionWithDefaults instantiates a new ServerlessInstanceDescription object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetConnectionStrings + +`func (o *ServerlessInstanceDescription) GetConnectionStrings() ServerlessInstanceDescriptionConnectionStrings` + +GetConnectionStrings returns the ConnectionStrings field if non-nil, zero value otherwise. + +### GetConnectionStringsOk + +`func (o *ServerlessInstanceDescription) GetConnectionStringsOk() (*ServerlessInstanceDescriptionConnectionStrings, bool)` + +GetConnectionStringsOk returns a tuple with the ConnectionStrings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionStrings + +`func (o *ServerlessInstanceDescription) SetConnectionStrings(v ServerlessInstanceDescriptionConnectionStrings)` + +SetConnectionStrings sets ConnectionStrings field to given value. + +### HasConnectionStrings + +`func (o *ServerlessInstanceDescription) HasConnectionStrings() bool` + +HasConnectionStrings returns a boolean if a field has been set. + +### GetCreateDate + +`func (o *ServerlessInstanceDescription) GetCreateDate() time.Time` + +GetCreateDate returns the CreateDate field if non-nil, zero value otherwise. + +### GetCreateDateOk + +`func (o *ServerlessInstanceDescription) GetCreateDateOk() (*time.Time, bool)` + +GetCreateDateOk returns a tuple with the CreateDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreateDate + +`func (o *ServerlessInstanceDescription) SetCreateDate(v time.Time)` + +SetCreateDate sets CreateDate field to given value. + +### HasCreateDate + +`func (o *ServerlessInstanceDescription) HasCreateDate() bool` + +HasCreateDate returns a boolean if a field has been set. + +### GetGroupId + +`func (o *ServerlessInstanceDescription) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ServerlessInstanceDescription) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ServerlessInstanceDescription) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ServerlessInstanceDescription) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ServerlessInstanceDescription) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServerlessInstanceDescription) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServerlessInstanceDescription) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServerlessInstanceDescription) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ServerlessInstanceDescription) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ServerlessInstanceDescription) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ServerlessInstanceDescription) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ServerlessInstanceDescription) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMongoDBVersion + +`func (o *ServerlessInstanceDescription) GetMongoDBVersion() string` + +GetMongoDBVersion returns the MongoDBVersion field if non-nil, zero value otherwise. + +### GetMongoDBVersionOk + +`func (o *ServerlessInstanceDescription) GetMongoDBVersionOk() (*string, bool)` + +GetMongoDBVersionOk returns a tuple with the MongoDBVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoDBVersion + +`func (o *ServerlessInstanceDescription) SetMongoDBVersion(v string)` + +SetMongoDBVersion sets MongoDBVersion field to given value. + +### HasMongoDBVersion + +`func (o *ServerlessInstanceDescription) HasMongoDBVersion() bool` + +HasMongoDBVersion returns a boolean if a field has been set. + +### GetName + +`func (o *ServerlessInstanceDescription) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServerlessInstanceDescription) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServerlessInstanceDescription) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServerlessInstanceDescription) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProviderSettings + +`func (o *ServerlessInstanceDescription) GetProviderSettings() ServerlessProviderSettings` + +GetProviderSettings returns the ProviderSettings field if non-nil, zero value otherwise. + +### GetProviderSettingsOk + +`func (o *ServerlessInstanceDescription) GetProviderSettingsOk() (*ServerlessProviderSettings, bool)` + +GetProviderSettingsOk returns a tuple with the ProviderSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderSettings + +`func (o *ServerlessInstanceDescription) SetProviderSettings(v ServerlessProviderSettings)` + +SetProviderSettings sets ProviderSettings field to given value. + + +### GetServerlessBackupOptions + +`func (o *ServerlessInstanceDescription) GetServerlessBackupOptions() ServerlessBackupOptions` + +GetServerlessBackupOptions returns the ServerlessBackupOptions field if non-nil, zero value otherwise. + +### GetServerlessBackupOptionsOk + +`func (o *ServerlessInstanceDescription) GetServerlessBackupOptionsOk() (*ServerlessBackupOptions, bool)` + +GetServerlessBackupOptionsOk returns a tuple with the ServerlessBackupOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerlessBackupOptions + +`func (o *ServerlessInstanceDescription) SetServerlessBackupOptions(v ServerlessBackupOptions)` + +SetServerlessBackupOptions sets ServerlessBackupOptions field to given value. + +### HasServerlessBackupOptions + +`func (o *ServerlessInstanceDescription) HasServerlessBackupOptions() bool` + +HasServerlessBackupOptions returns a boolean if a field has been set. + +### GetStateName + +`func (o *ServerlessInstanceDescription) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *ServerlessInstanceDescription) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *ServerlessInstanceDescription) SetStateName(v string)` + +SetStateName sets StateName field to given value. + +### HasStateName + +`func (o *ServerlessInstanceDescription) HasStateName() bool` + +HasStateName returns a boolean if a field has been set. + +### GetTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescription) GetTerminationProtectionEnabled() bool` + +GetTerminationProtectionEnabled returns the TerminationProtectionEnabled field if non-nil, zero value otherwise. + +### GetTerminationProtectionEnabledOk + +`func (o *ServerlessInstanceDescription) GetTerminationProtectionEnabledOk() (*bool, bool)` + +GetTerminationProtectionEnabledOk returns a tuple with the TerminationProtectionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescription) SetTerminationProtectionEnabled(v bool)` + +SetTerminationProtectionEnabled sets TerminationProtectionEnabled field to given value. + +### HasTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescription) HasTerminationProtectionEnabled() bool` + +HasTerminationProtectionEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessInstanceDescriptionConnectionStrings.md b/docs/docs/ServerlessInstanceDescriptionConnectionStrings.md new file mode 100644 index 00000000..1c91582c --- /dev/null +++ b/docs/docs/ServerlessInstanceDescriptionConnectionStrings.md @@ -0,0 +1,82 @@ +# ServerlessInstanceDescriptionConnectionStrings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PrivateEndpoint** | Pointer to [**[]ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint**](ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint.md) | List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE. | [optional] [readonly] +**StandardSrv** | Pointer to **string** | Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol. | [optional] [readonly] + +## Methods + +### NewServerlessInstanceDescriptionConnectionStrings + +`func NewServerlessInstanceDescriptionConnectionStrings() *ServerlessInstanceDescriptionConnectionStrings` + +NewServerlessInstanceDescriptionConnectionStrings instantiates a new ServerlessInstanceDescriptionConnectionStrings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessInstanceDescriptionConnectionStringsWithDefaults + +`func NewServerlessInstanceDescriptionConnectionStringsWithDefaults() *ServerlessInstanceDescriptionConnectionStrings` + +NewServerlessInstanceDescriptionConnectionStringsWithDefaults instantiates a new ServerlessInstanceDescriptionConnectionStrings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPrivateEndpoint + +`func (o *ServerlessInstanceDescriptionConnectionStrings) GetPrivateEndpoint() []ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint` + +GetPrivateEndpoint returns the PrivateEndpoint field if non-nil, zero value otherwise. + +### GetPrivateEndpointOk + +`func (o *ServerlessInstanceDescriptionConnectionStrings) GetPrivateEndpointOk() (*[]ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint, bool)` + +GetPrivateEndpointOk returns a tuple with the PrivateEndpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpoint + +`func (o *ServerlessInstanceDescriptionConnectionStrings) SetPrivateEndpoint(v []ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint)` + +SetPrivateEndpoint sets PrivateEndpoint field to given value. + +### HasPrivateEndpoint + +`func (o *ServerlessInstanceDescriptionConnectionStrings) HasPrivateEndpoint() bool` + +HasPrivateEndpoint returns a boolean if a field has been set. + +### GetStandardSrv + +`func (o *ServerlessInstanceDescriptionConnectionStrings) GetStandardSrv() string` + +GetStandardSrv returns the StandardSrv field if non-nil, zero value otherwise. + +### GetStandardSrvOk + +`func (o *ServerlessInstanceDescriptionConnectionStrings) GetStandardSrvOk() (*string, bool)` + +GetStandardSrvOk returns a tuple with the StandardSrv field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandardSrv + +`func (o *ServerlessInstanceDescriptionConnectionStrings) SetStandardSrv(v string)` + +SetStandardSrv sets StandardSrv field to given value. + +### HasStandardSrv + +`func (o *ServerlessInstanceDescriptionConnectionStrings) HasStandardSrv() bool` + +HasStandardSrv returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint.md b/docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint.md new file mode 100644 index 00000000..9be4f836 --- /dev/null +++ b/docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint.md @@ -0,0 +1,108 @@ +# ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Endpoints** | Pointer to [**[]ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint**](ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint.md) | List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**. | [optional] [readonly] +**SrvConnectionString** | Pointer to **string** | Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). | [optional] [readonly] +**Type** | Pointer to **string** | MongoDB process type to which your application connects. | [optional] [readonly] + +## Methods + +### NewServerlessInstanceDescriptionConnectionStringsPrivateEndpoint + +`func NewServerlessInstanceDescriptionConnectionStringsPrivateEndpoint() *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint` + +NewServerlessInstanceDescriptionConnectionStringsPrivateEndpoint instantiates a new ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointWithDefaults + +`func NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointWithDefaults() *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint` + +NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointWithDefaults instantiates a new ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpoints + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) GetEndpoints() []ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint` + +GetEndpoints returns the Endpoints field if non-nil, zero value otherwise. + +### GetEndpointsOk + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) GetEndpointsOk() (*[]ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint, bool)` + +GetEndpointsOk returns a tuple with the Endpoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpoints + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) SetEndpoints(v []ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint)` + +SetEndpoints sets Endpoints field to given value. + +### HasEndpoints + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) HasEndpoints() bool` + +HasEndpoints returns a boolean if a field has been set. + +### GetSrvConnectionString + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) GetSrvConnectionString() string` + +GetSrvConnectionString returns the SrvConnectionString field if non-nil, zero value otherwise. + +### GetSrvConnectionStringOk + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) GetSrvConnectionStringOk() (*string, bool)` + +GetSrvConnectionStringOk returns a tuple with the SrvConnectionString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSrvConnectionString + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) SetSrvConnectionString(v string)` + +SetSrvConnectionString sets SrvConnectionString field to given value. + +### HasSrvConnectionString + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) HasSrvConnectionString() bool` + +HasSrvConnectionString returns a boolean if a field has been set. + +### GetType + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpoint) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint.md b/docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint.md new file mode 100644 index 00000000..95d57503 --- /dev/null +++ b/docs/docs/ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint.md @@ -0,0 +1,108 @@ +# ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndpointId** | Pointer to **string** | Unique string that the cloud provider uses to identify the private endpoint. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Cloud provider where the private endpoint is deployed. | [optional] [readonly] +**Region** | Pointer to **string** | Region where the private endpoint is deployed. | [optional] [readonly] + +## Methods + +### NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint + +`func NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint() *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint` + +NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint instantiates a new ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpointWithDefaults + +`func NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpointWithDefaults() *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint` + +NewServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpointWithDefaults instantiates a new ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEndpointId + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) GetEndpointId() string` + +GetEndpointId returns the EndpointId field if non-nil, zero value otherwise. + +### GetEndpointIdOk + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) GetEndpointIdOk() (*string, bool)` + +GetEndpointIdOk returns a tuple with the EndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointId + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) SetEndpointId(v string)` + +SetEndpointId sets EndpointId field to given value. + +### HasEndpointId + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) HasEndpointId() bool` + +HasEndpointId returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegion + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *ServerlessInstanceDescriptionConnectionStringsPrivateEndpointEndpoint) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessInstanceDescriptionCreate.md b/docs/docs/ServerlessInstanceDescriptionCreate.md new file mode 100644 index 00000000..2e51915e --- /dev/null +++ b/docs/docs/ServerlessInstanceDescriptionCreate.md @@ -0,0 +1,150 @@ +# ServerlessInstanceDescriptionCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Human-readable label that identifies the serverless instance. | +**ProviderSettings** | [**ServerlessProviderSettings**](ServerlessProviderSettings.md) | | +**ServerlessBackupOptions** | Pointer to [**ServerlessBackupOptions**](ServerlessBackupOptions.md) | | [optional] +**StateName** | Pointer to **string** | Human-readable label that indicates the current operating condition of the serverless instance. | [optional] [readonly] +**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance. | [optional] [default to false] + +## Methods + +### NewServerlessInstanceDescriptionCreate + +`func NewServerlessInstanceDescriptionCreate(name string, providerSettings ServerlessProviderSettings, ) *ServerlessInstanceDescriptionCreate` + +NewServerlessInstanceDescriptionCreate instantiates a new ServerlessInstanceDescriptionCreate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessInstanceDescriptionCreateWithDefaults + +`func NewServerlessInstanceDescriptionCreateWithDefaults() *ServerlessInstanceDescriptionCreate` + +NewServerlessInstanceDescriptionCreateWithDefaults instantiates a new ServerlessInstanceDescriptionCreate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *ServerlessInstanceDescriptionCreate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServerlessInstanceDescriptionCreate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServerlessInstanceDescriptionCreate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetProviderSettings + +`func (o *ServerlessInstanceDescriptionCreate) GetProviderSettings() ServerlessProviderSettings` + +GetProviderSettings returns the ProviderSettings field if non-nil, zero value otherwise. + +### GetProviderSettingsOk + +`func (o *ServerlessInstanceDescriptionCreate) GetProviderSettingsOk() (*ServerlessProviderSettings, bool)` + +GetProviderSettingsOk returns a tuple with the ProviderSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderSettings + +`func (o *ServerlessInstanceDescriptionCreate) SetProviderSettings(v ServerlessProviderSettings)` + +SetProviderSettings sets ProviderSettings field to given value. + + +### GetServerlessBackupOptions + +`func (o *ServerlessInstanceDescriptionCreate) GetServerlessBackupOptions() ServerlessBackupOptions` + +GetServerlessBackupOptions returns the ServerlessBackupOptions field if non-nil, zero value otherwise. + +### GetServerlessBackupOptionsOk + +`func (o *ServerlessInstanceDescriptionCreate) GetServerlessBackupOptionsOk() (*ServerlessBackupOptions, bool)` + +GetServerlessBackupOptionsOk returns a tuple with the ServerlessBackupOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerlessBackupOptions + +`func (o *ServerlessInstanceDescriptionCreate) SetServerlessBackupOptions(v ServerlessBackupOptions)` + +SetServerlessBackupOptions sets ServerlessBackupOptions field to given value. + +### HasServerlessBackupOptions + +`func (o *ServerlessInstanceDescriptionCreate) HasServerlessBackupOptions() bool` + +HasServerlessBackupOptions returns a boolean if a field has been set. + +### GetStateName + +`func (o *ServerlessInstanceDescriptionCreate) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *ServerlessInstanceDescriptionCreate) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *ServerlessInstanceDescriptionCreate) SetStateName(v string)` + +SetStateName sets StateName field to given value. + +### HasStateName + +`func (o *ServerlessInstanceDescriptionCreate) HasStateName() bool` + +HasStateName returns a boolean if a field has been set. + +### GetTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescriptionCreate) GetTerminationProtectionEnabled() bool` + +GetTerminationProtectionEnabled returns the TerminationProtectionEnabled field if non-nil, zero value otherwise. + +### GetTerminationProtectionEnabledOk + +`func (o *ServerlessInstanceDescriptionCreate) GetTerminationProtectionEnabledOk() (*bool, bool)` + +GetTerminationProtectionEnabledOk returns a tuple with the TerminationProtectionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescriptionCreate) SetTerminationProtectionEnabled(v bool)` + +SetTerminationProtectionEnabled sets TerminationProtectionEnabled field to given value. + +### HasTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescriptionCreate) HasTerminationProtectionEnabled() bool` + +HasTerminationProtectionEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessInstanceDescriptionUpdate.md b/docs/docs/ServerlessInstanceDescriptionUpdate.md new file mode 100644 index 00000000..4c7fa582 --- /dev/null +++ b/docs/docs/ServerlessInstanceDescriptionUpdate.md @@ -0,0 +1,82 @@ +# ServerlessInstanceDescriptionUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ServerlessBackupOptions** | Pointer to [**ServerlessBackupOptions**](ServerlessBackupOptions.md) | | [optional] +**TerminationProtectionEnabled** | Pointer to **bool** | Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance. | [optional] [default to false] + +## Methods + +### NewServerlessInstanceDescriptionUpdate + +`func NewServerlessInstanceDescriptionUpdate() *ServerlessInstanceDescriptionUpdate` + +NewServerlessInstanceDescriptionUpdate instantiates a new ServerlessInstanceDescriptionUpdate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessInstanceDescriptionUpdateWithDefaults + +`func NewServerlessInstanceDescriptionUpdateWithDefaults() *ServerlessInstanceDescriptionUpdate` + +NewServerlessInstanceDescriptionUpdateWithDefaults instantiates a new ServerlessInstanceDescriptionUpdate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetServerlessBackupOptions + +`func (o *ServerlessInstanceDescriptionUpdate) GetServerlessBackupOptions() ServerlessBackupOptions` + +GetServerlessBackupOptions returns the ServerlessBackupOptions field if non-nil, zero value otherwise. + +### GetServerlessBackupOptionsOk + +`func (o *ServerlessInstanceDescriptionUpdate) GetServerlessBackupOptionsOk() (*ServerlessBackupOptions, bool)` + +GetServerlessBackupOptionsOk returns a tuple with the ServerlessBackupOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerlessBackupOptions + +`func (o *ServerlessInstanceDescriptionUpdate) SetServerlessBackupOptions(v ServerlessBackupOptions)` + +SetServerlessBackupOptions sets ServerlessBackupOptions field to given value. + +### HasServerlessBackupOptions + +`func (o *ServerlessInstanceDescriptionUpdate) HasServerlessBackupOptions() bool` + +HasServerlessBackupOptions returns a boolean if a field has been set. + +### GetTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescriptionUpdate) GetTerminationProtectionEnabled() bool` + +GetTerminationProtectionEnabled returns the TerminationProtectionEnabled field if non-nil, zero value otherwise. + +### GetTerminationProtectionEnabledOk + +`func (o *ServerlessInstanceDescriptionUpdate) GetTerminationProtectionEnabledOk() (*bool, bool)` + +GetTerminationProtectionEnabledOk returns a tuple with the TerminationProtectionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescriptionUpdate) SetTerminationProtectionEnabled(v bool)` + +SetTerminationProtectionEnabled sets TerminationProtectionEnabled field to given value. + +### HasTerminationProtectionEnabled + +`func (o *ServerlessInstanceDescriptionUpdate) HasTerminationProtectionEnabled() bool` + +HasTerminationProtectionEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessInstancesApi.md b/docs/docs/ServerlessInstancesApi.md new file mode 100644 index 00000000..78a3baa6 --- /dev/null +++ b/docs/docs/ServerlessInstancesApi.md @@ -0,0 +1,400 @@ +# \ServerlessInstancesApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateServerlessInstance**](ServerlessInstancesApi.md#CreateServerlessInstance) | **Post** /api/atlas/v2/groups/{groupId}/serverless | Create One Serverless Instance in One Project +[**DeleteServerlessInstance**](ServerlessInstancesApi.md#DeleteServerlessInstance) | **Delete** /api/atlas/v2/groups/{groupId}/serverless/{name} | Remove One Serverless Instance from One Project +[**GetServerlessInstance**](ServerlessInstancesApi.md#GetServerlessInstance) | **Get** /api/atlas/v2/groups/{groupId}/serverless/{name} | Return One Serverless Instance from One Project +[**ListServerlessInstances**](ServerlessInstancesApi.md#ListServerlessInstances) | **Get** /api/atlas/v2/groups/{groupId}/serverless | Return All Serverless Instances from One Project +[**UpdateServerlessInstance**](ServerlessInstancesApi.md#UpdateServerlessInstance) | **Patch** /api/atlas/v2/groups/{groupId}/serverless/{name} | Update One Serverless Instance in One Project + + + +## CreateServerlessInstance + +> ServerlessInstanceDescription CreateServerlessInstance(ctx, groupId).ServerlessInstanceDescriptionCreate(serverlessInstanceDescriptionCreate).Execute() + +Create One Serverless Instance in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + serverlessInstanceDescriptionCreate := *openapiclient.NewServerlessInstanceDescriptionCreate("Name_example", *openapiclient.NewServerlessProviderSettings("BackingProviderName_example", "RegionName_example")) // ServerlessInstanceDescriptionCreate | + + resp, r, err := sdk.ServerlessInstancesApi.CreateServerlessInstance(context.Background(), groupId).ServerlessInstanceDescriptionCreate(serverlessInstanceDescriptionCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessInstancesApi.CreateServerlessInstance``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateServerlessInstance`: ServerlessInstanceDescription + fmt.Fprintf(os.Stdout, "Response from `ServerlessInstancesApi.CreateServerlessInstance`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServerlessInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **serverlessInstanceDescriptionCreate** | [**ServerlessInstanceDescriptionCreate**](ServerlessInstanceDescriptionCreate.md) | Create One Serverless Instance in One Project. | + +### Return type + +[**ServerlessInstanceDescription**](ServerlessInstanceDescription.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteServerlessInstance + +> DeleteServerlessInstance(ctx, groupId, name).Execute() + +Remove One Serverless Instance from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + name := "name_example" // string | + + r, err := sdk.ServerlessInstancesApi.DeleteServerlessInstance(context.Background(), groupId, name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessInstancesApi.DeleteServerlessInstance``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**name** | **string** | Human-readable label that identifies the serverless instance. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServerlessInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerlessInstance + +> ServerlessInstanceDescription GetServerlessInstance(ctx, groupId, name).Execute() + +Return One Serverless Instance from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + name := "name_example" // string | + + resp, r, err := sdk.ServerlessInstancesApi.GetServerlessInstance(context.Background(), groupId, name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessInstancesApi.GetServerlessInstance``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetServerlessInstance`: ServerlessInstanceDescription + fmt.Fprintf(os.Stdout, "Response from `ServerlessInstancesApi.GetServerlessInstance`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**name** | **string** | Human-readable label that identifies the serverless instance. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerlessInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ServerlessInstanceDescription**](ServerlessInstanceDescription.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListServerlessInstances + +> PaginatedServerlessInstanceDescription ListServerlessInstances(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Serverless Instances from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ServerlessInstancesApi.ListServerlessInstances(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessInstancesApi.ListServerlessInstances``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListServerlessInstances`: PaginatedServerlessInstanceDescription + fmt.Fprintf(os.Stdout, "Response from `ServerlessInstancesApi.ListServerlessInstances`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListServerlessInstancesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedServerlessInstanceDescription**](PaginatedServerlessInstanceDescription.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateServerlessInstance + +> ServerlessInstanceDescription UpdateServerlessInstance(ctx, groupId, name).ServerlessInstanceDescriptionUpdate(serverlessInstanceDescriptionUpdate).Execute() + +Update One Serverless Instance in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + name := "name_example" // string | + serverlessInstanceDescriptionUpdate := *openapiclient.NewServerlessInstanceDescriptionUpdate() // ServerlessInstanceDescriptionUpdate | + + resp, r, err := sdk.ServerlessInstancesApi.UpdateServerlessInstance(context.Background(), groupId, name).ServerlessInstanceDescriptionUpdate(serverlessInstanceDescriptionUpdate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessInstancesApi.UpdateServerlessInstance``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateServerlessInstance`: ServerlessInstanceDescription + fmt.Fprintf(os.Stdout, "Response from `ServerlessInstancesApi.UpdateServerlessInstance`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**name** | **string** | Human-readable label that identifies the serverless instance. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateServerlessInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **serverlessInstanceDescriptionUpdate** | [**ServerlessInstanceDescriptionUpdate**](ServerlessInstanceDescriptionUpdate.md) | Update One Serverless Instance in One Project. | + +### Return type + +[**ServerlessInstanceDescription**](ServerlessInstanceDescription.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ServerlessMetricAlertConfigViewForNdsGroup.md b/docs/docs/ServerlessMetricAlertConfigViewForNdsGroup.md new file mode 100644 index 00000000..8960c2d8 --- /dev/null +++ b/docs/docs/ServerlessMetricAlertConfigViewForNdsGroup.md @@ -0,0 +1,285 @@ +# ServerlessMetricAlertConfigViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **time.Time** | Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Flag that indicates whether someone enabled this alert configuration for the specified project. | [optional] [default to false] +**EventTypeName** | [**ServerlessEventTypeViewAlertable**](ServerlessEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this alert configuration. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Matchers** | Pointer to **[]map[string]interface{}** | No matchers are available for these alert types. The list is always empty. | [optional] [readonly] +**MetricThreshold** | Pointer to [**ServerlessMetricThreshold**](ServerlessMetricThreshold.md) | | [optional] +**Notifications** | Pointer to [**[]NotificationViewForNdsGroup**](NotificationViewForNdsGroup.md) | List that contains the targets that MongoDB Cloud sends notifications. | [optional] +**Updated** | Pointer to **time.Time** | Date and time when someone last updated this alert configuration. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [optional] [readonly] + +## Methods + +### NewServerlessMetricAlertConfigViewForNdsGroup + +`func NewServerlessMetricAlertConfigViewForNdsGroup(eventTypeName ServerlessEventTypeViewAlertable, ) *ServerlessMetricAlertConfigViewForNdsGroup` + +NewServerlessMetricAlertConfigViewForNdsGroup instantiates a new ServerlessMetricAlertConfigViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessMetricAlertConfigViewForNdsGroupWithDefaults + +`func NewServerlessMetricAlertConfigViewForNdsGroupWithDefaults() *ServerlessMetricAlertConfigViewForNdsGroup` + +NewServerlessMetricAlertConfigViewForNdsGroupWithDefaults instantiates a new ServerlessMetricAlertConfigViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetEnabled + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetEventTypeName() ServerlessEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetEventTypeNameOk() (*ServerlessEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetEventTypeName(v ServerlessEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMatchers + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetMatchers() []map[string]interface{}` + +GetMatchers returns the Matchers field if non-nil, zero value otherwise. + +### GetMatchersOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetMatchersOk() (*[]map[string]interface{}, bool)` + +GetMatchersOk returns a tuple with the Matchers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchers + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetMatchers(v []map[string]interface{})` + +SetMatchers sets Matchers field to given value. + +### HasMatchers + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasMatchers() bool` + +HasMatchers returns a boolean if a field has been set. + +### GetMetricThreshold + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetMetricThreshold() ServerlessMetricThreshold` + +GetMetricThreshold returns the MetricThreshold field if non-nil, zero value otherwise. + +### GetMetricThresholdOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetMetricThresholdOk() (*ServerlessMetricThreshold, bool)` + +GetMetricThresholdOk returns a tuple with the MetricThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricThreshold + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetMetricThreshold(v ServerlessMetricThreshold)` + +SetMetricThreshold sets MetricThreshold field to given value. + +### HasMetricThreshold + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasMetricThreshold() bool` + +HasMetricThreshold returns a boolean if a field has been set. + +### GetNotifications + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetNotifications() []NotificationViewForNdsGroup` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetNotificationsOk() (*[]NotificationViewForNdsGroup, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifications + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetNotifications(v []NotificationViewForNdsGroup)` + +SetNotifications sets Notifications field to given value. + +### HasNotifications + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### GetUpdated + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *ServerlessMetricAlertConfigViewForNdsGroup) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessMetricThreshold.md b/docs/docs/ServerlessMetricThreshold.md new file mode 100644 index 00000000..f523bbf7 --- /dev/null +++ b/docs/docs/ServerlessMetricThreshold.md @@ -0,0 +1,160 @@ +# ServerlessMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**ServerlessMetricUnits**](ServerlessMetricUnits.md) | | [optional] + +## Methods + +### NewServerlessMetricThreshold + +`func NewServerlessMetricThreshold() *ServerlessMetricThreshold` + +NewServerlessMetricThreshold instantiates a new ServerlessMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessMetricThresholdWithDefaults + +`func NewServerlessMetricThresholdWithDefaults() *ServerlessMetricThreshold` + +NewServerlessMetricThresholdWithDefaults instantiates a new ServerlessMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *ServerlessMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *ServerlessMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *ServerlessMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *ServerlessMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *ServerlessMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *ServerlessMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *ServerlessMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *ServerlessMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *ServerlessMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ServerlessMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ServerlessMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ServerlessMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *ServerlessMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *ServerlessMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *ServerlessMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *ServerlessMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *ServerlessMetricThreshold) GetUnits() ServerlessMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *ServerlessMetricThreshold) GetUnitsOk() (*ServerlessMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *ServerlessMetricThreshold) SetUnits(v ServerlessMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *ServerlessMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessMetricUnits.md b/docs/docs/ServerlessMetricUnits.md new file mode 100644 index 00000000..bf5e40a3 --- /dev/null +++ b/docs/docs/ServerlessMetricUnits.md @@ -0,0 +1,21 @@ +# ServerlessMetricUnits + +## Enum + + +* `RPU` (value: `"RPU"`) + +* `THOUSAND_RPU` (value: `"THOUSAND_RPU"`) + +* `MILLION_RPU` (value: `"MILLION_RPU"`) + +* `WPU` (value: `"WPU"`) + +* `THOUSAND_WPU` (value: `"THOUSAND_WPU"`) + +* `MILLION_WPU` (value: `"MILLION_WPU"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessPrivateEndpointsApi.md b/docs/docs/ServerlessPrivateEndpointsApi.md new file mode 100644 index 00000000..21d9955d --- /dev/null +++ b/docs/docs/ServerlessPrivateEndpointsApi.md @@ -0,0 +1,409 @@ +# \ServerlessPrivateEndpointsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateServerlessPrivateEndpoint**](ServerlessPrivateEndpointsApi.md#CreateServerlessPrivateEndpoint) | **Post** /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint | Create One Private Endpoint for One Serverless Instance +[**DeleteServerlessPrivateEndpoint**](ServerlessPrivateEndpointsApi.md#DeleteServerlessPrivateEndpoint) | **Delete** /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId} | Remove One Private Endpoint for One Serverless Instance +[**GetServerlessPrivateEndpoint**](ServerlessPrivateEndpointsApi.md#GetServerlessPrivateEndpoint) | **Get** /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId} | Return One Private Endpoint for One Serverless Instance +[**ListServerlessPrivateEndpoints**](ServerlessPrivateEndpointsApi.md#ListServerlessPrivateEndpoints) | **Get** /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint | Return All Private Endpoints for One Serverless Instance +[**UpdateServerlessPrivateEndpoint**](ServerlessPrivateEndpointsApi.md#UpdateServerlessPrivateEndpoint) | **Patch** /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId} | Update One Private Endpoint for One Serverless Instance + + + +## CreateServerlessPrivateEndpoint + +> ServerlessTenantEndpoint CreateServerlessPrivateEndpoint(ctx, groupId, instanceName).ServerlessTenantEndpointCreate(serverlessTenantEndpointCreate).Execute() + +Create One Private Endpoint for One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + instanceName := "instanceName_example" // string | + serverlessTenantEndpointCreate := *openapiclient.NewServerlessTenantEndpointCreate() // ServerlessTenantEndpointCreate | + + resp, r, err := sdk.ServerlessPrivateEndpointsApi.CreateServerlessPrivateEndpoint(context.Background(), groupId, instanceName).ServerlessTenantEndpointCreate(serverlessTenantEndpointCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessPrivateEndpointsApi.CreateServerlessPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateServerlessPrivateEndpoint`: ServerlessTenantEndpoint + fmt.Fprintf(os.Stdout, "Response from `ServerlessPrivateEndpointsApi.CreateServerlessPrivateEndpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**instanceName** | **string** | Human-readable label that identifies the serverless instance for which the tenant endpoint will be created. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServerlessPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **serverlessTenantEndpointCreate** | [**ServerlessTenantEndpointCreate**](ServerlessTenantEndpointCreate.md) | Information about the Private Endpoint to create for the Serverless Instance. | + +### Return type + +[**ServerlessTenantEndpoint**](ServerlessTenantEndpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteServerlessPrivateEndpoint + +> DeleteServerlessPrivateEndpoint(ctx, groupId, instanceName, endpointId).Execute() + +Remove One Private Endpoint for One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + instanceName := "instanceName_example" // string | + endpointId := "endpointId_example" // string | + + r, err := sdk.ServerlessPrivateEndpointsApi.DeleteServerlessPrivateEndpoint(context.Background(), groupId, instanceName, endpointId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessPrivateEndpointsApi.DeleteServerlessPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**instanceName** | **string** | Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed. | +**endpointId** | **string** | Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServerlessPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerlessPrivateEndpoint + +> ServerlessTenantEndpoint GetServerlessPrivateEndpoint(ctx, groupId, instanceName, endpointId).Execute() + +Return One Private Endpoint for One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + instanceName := "instanceName_example" // string | + endpointId := "endpointId_example" // string | + + resp, r, err := sdk.ServerlessPrivateEndpointsApi.GetServerlessPrivateEndpoint(context.Background(), groupId, instanceName, endpointId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessPrivateEndpointsApi.GetServerlessPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetServerlessPrivateEndpoint`: ServerlessTenantEndpoint + fmt.Fprintf(os.Stdout, "Response from `ServerlessPrivateEndpointsApi.GetServerlessPrivateEndpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**instanceName** | **string** | Human-readable label that identifies the serverless instance associated with the tenant endpoint. | +**endpointId** | **string** | Unique 24-hexadecimal digit string that identifies the tenant endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerlessPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**ServerlessTenantEndpoint**](ServerlessTenantEndpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListServerlessPrivateEndpoints + +> []ServerlessTenantEndpoint ListServerlessPrivateEndpoints(ctx, groupId, instanceName).Execute() + +Return All Private Endpoints for One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + instanceName := "instanceName_example" // string | + + resp, r, err := sdk.ServerlessPrivateEndpointsApi.ListServerlessPrivateEndpoints(context.Background(), groupId, instanceName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessPrivateEndpointsApi.ListServerlessPrivateEndpoints``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListServerlessPrivateEndpoints`: []ServerlessTenantEndpoint + fmt.Fprintf(os.Stdout, "Response from `ServerlessPrivateEndpointsApi.ListServerlessPrivateEndpoints`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**instanceName** | **string** | Human-readable label that identifies the serverless instance associated with the tenant endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListServerlessPrivateEndpointsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**[]ServerlessTenantEndpoint**](ServerlessTenantEndpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateServerlessPrivateEndpoint + +> ServerlessTenantEndpoint UpdateServerlessPrivateEndpoint(ctx, groupId, instanceName, endpointId).ServerlessTenantEndpointUpdate(serverlessTenantEndpointUpdate).Execute() + +Update One Private Endpoint for One Serverless Instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + instanceName := "instanceName_example" // string | + endpointId := "endpointId_example" // string | + serverlessTenantEndpointUpdate := openapiclient.ServerlessTenantEndpointUpdate{ServerlessAWSTenantEndpointUpdate: openapiclient.NewServerlessAWSTenantEndpointUpdate("ProviderName_example")} // ServerlessTenantEndpointUpdate | (optional) + + resp, r, err := sdk.ServerlessPrivateEndpointsApi.UpdateServerlessPrivateEndpoint(context.Background(), groupId, instanceName, endpointId).ServerlessTenantEndpointUpdate(serverlessTenantEndpointUpdate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServerlessPrivateEndpointsApi.UpdateServerlessPrivateEndpoint``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateServerlessPrivateEndpoint`: ServerlessTenantEndpoint + fmt.Fprintf(os.Stdout, "Response from `ServerlessPrivateEndpointsApi.UpdateServerlessPrivateEndpoint`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**instanceName** | **string** | Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated. | +**endpointId** | **string** | Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateServerlessPrivateEndpointRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **serverlessTenantEndpointUpdate** | [**ServerlessTenantEndpointUpdate**](ServerlessTenantEndpointUpdate.md) | | + +### Return type + +[**ServerlessTenantEndpoint**](ServerlessTenantEndpoint.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ServerlessProviderSettings.md b/docs/docs/ServerlessProviderSettings.md new file mode 100644 index 00000000..7153f7ae --- /dev/null +++ b/docs/docs/ServerlessProviderSettings.md @@ -0,0 +1,98 @@ +# ServerlessProviderSettings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BackingProviderName** | **string** | Cloud service provider on which MongoDB Cloud provisioned the serverless instance. | +**ProviderName** | Pointer to **string** | Human-readable label that identifies the cloud service provider. | [optional] [default to "SERVERLESS"] +**RegionName** | **string** | Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). | + +## Methods + +### NewServerlessProviderSettings + +`func NewServerlessProviderSettings(backingProviderName string, regionName string, ) *ServerlessProviderSettings` + +NewServerlessProviderSettings instantiates a new ServerlessProviderSettings object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessProviderSettingsWithDefaults + +`func NewServerlessProviderSettingsWithDefaults() *ServerlessProviderSettings` + +NewServerlessProviderSettingsWithDefaults instantiates a new ServerlessProviderSettings object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBackingProviderName + +`func (o *ServerlessProviderSettings) GetBackingProviderName() string` + +GetBackingProviderName returns the BackingProviderName field if non-nil, zero value otherwise. + +### GetBackingProviderNameOk + +`func (o *ServerlessProviderSettings) GetBackingProviderNameOk() (*string, bool)` + +GetBackingProviderNameOk returns a tuple with the BackingProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackingProviderName + +`func (o *ServerlessProviderSettings) SetBackingProviderName(v string)` + +SetBackingProviderName sets BackingProviderName field to given value. + + +### GetProviderName + +`func (o *ServerlessProviderSettings) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessProviderSettings) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessProviderSettings) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *ServerlessProviderSettings) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *ServerlessProviderSettings) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *ServerlessProviderSettings) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *ServerlessProviderSettings) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessTenantEndpoint.md b/docs/docs/ServerlessTenantEndpoint.md new file mode 100644 index 00000000..04939075 --- /dev/null +++ b/docs/docs/ServerlessTenantEndpoint.md @@ -0,0 +1,264 @@ +# ServerlessTenantEndpoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the private endpoint. | [optional] [readonly] +**CloudProviderEndpointId** | Pointer to **string** | Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service. | [optional] [readonly] +**Comment** | Pointer to **string** | Human-readable comment associated with the private endpoint. | [optional] [readonly] +**EndpointServiceName** | Pointer to **string** | Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service. | [optional] [readonly] +**ErrorMessage** | Pointer to **string** | Human-readable error message that indicates error condition associated with establishing the private endpoint connection. | [optional] [readonly] +**ProviderName** | Pointer to **string** | Human-readable label that identifies the cloud service provider. | [optional] [readonly] +**Status** | Pointer to **string** | Human-readable label that indicates the current operating status of the private endpoint. | [optional] [readonly] +**PrivateEndpointIpAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] [readonly] +**PrivateLinkServiceResourceId** | Pointer to **string** | Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service. | [optional] [readonly] + +## Methods + +### NewServerlessTenantEndpoint + +`func NewServerlessTenantEndpoint() *ServerlessTenantEndpoint` + +NewServerlessTenantEndpoint instantiates a new ServerlessTenantEndpoint object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessTenantEndpointWithDefaults + +`func NewServerlessTenantEndpointWithDefaults() *ServerlessTenantEndpoint` + +NewServerlessTenantEndpointWithDefaults instantiates a new ServerlessTenantEndpoint object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *ServerlessTenantEndpoint) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServerlessTenantEndpoint) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServerlessTenantEndpoint) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServerlessTenantEndpoint) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudProviderEndpointId + +`func (o *ServerlessTenantEndpoint) GetCloudProviderEndpointId() string` + +GetCloudProviderEndpointId returns the CloudProviderEndpointId field if non-nil, zero value otherwise. + +### GetCloudProviderEndpointIdOk + +`func (o *ServerlessTenantEndpoint) GetCloudProviderEndpointIdOk() (*string, bool)` + +GetCloudProviderEndpointIdOk returns a tuple with the CloudProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProviderEndpointId + +`func (o *ServerlessTenantEndpoint) SetCloudProviderEndpointId(v string)` + +SetCloudProviderEndpointId sets CloudProviderEndpointId field to given value. + +### HasCloudProviderEndpointId + +`func (o *ServerlessTenantEndpoint) HasCloudProviderEndpointId() bool` + +HasCloudProviderEndpointId returns a boolean if a field has been set. + +### GetComment + +`func (o *ServerlessTenantEndpoint) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ServerlessTenantEndpoint) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ServerlessTenantEndpoint) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ServerlessTenantEndpoint) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetEndpointServiceName + +`func (o *ServerlessTenantEndpoint) GetEndpointServiceName() string` + +GetEndpointServiceName returns the EndpointServiceName field if non-nil, zero value otherwise. + +### GetEndpointServiceNameOk + +`func (o *ServerlessTenantEndpoint) GetEndpointServiceNameOk() (*string, bool)` + +GetEndpointServiceNameOk returns a tuple with the EndpointServiceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndpointServiceName + +`func (o *ServerlessTenantEndpoint) SetEndpointServiceName(v string)` + +SetEndpointServiceName sets EndpointServiceName field to given value. + +### HasEndpointServiceName + +`func (o *ServerlessTenantEndpoint) HasEndpointServiceName() bool` + +HasEndpointServiceName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ServerlessTenantEndpoint) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ServerlessTenantEndpoint) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ServerlessTenantEndpoint) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ServerlessTenantEndpoint) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ServerlessTenantEndpoint) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessTenantEndpoint) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessTenantEndpoint) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *ServerlessTenantEndpoint) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ServerlessTenantEndpoint) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ServerlessTenantEndpoint) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ServerlessTenantEndpoint) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ServerlessTenantEndpoint) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetPrivateEndpointIpAddress + +`func (o *ServerlessTenantEndpoint) GetPrivateEndpointIpAddress() string` + +GetPrivateEndpointIpAddress returns the PrivateEndpointIpAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIpAddressOk + +`func (o *ServerlessTenantEndpoint) GetPrivateEndpointIpAddressOk() (*string, bool)` + +GetPrivateEndpointIpAddressOk returns a tuple with the PrivateEndpointIpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIpAddress + +`func (o *ServerlessTenantEndpoint) SetPrivateEndpointIpAddress(v string)` + +SetPrivateEndpointIpAddress sets PrivateEndpointIpAddress field to given value. + +### HasPrivateEndpointIpAddress + +`func (o *ServerlessTenantEndpoint) HasPrivateEndpointIpAddress() bool` + +HasPrivateEndpointIpAddress returns a boolean if a field has been set. + +### GetPrivateLinkServiceResourceId + +`func (o *ServerlessTenantEndpoint) GetPrivateLinkServiceResourceId() string` + +GetPrivateLinkServiceResourceId returns the PrivateLinkServiceResourceId field if non-nil, zero value otherwise. + +### GetPrivateLinkServiceResourceIdOk + +`func (o *ServerlessTenantEndpoint) GetPrivateLinkServiceResourceIdOk() (*string, bool)` + +GetPrivateLinkServiceResourceIdOk returns a tuple with the PrivateLinkServiceResourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateLinkServiceResourceId + +`func (o *ServerlessTenantEndpoint) SetPrivateLinkServiceResourceId(v string)` + +SetPrivateLinkServiceResourceId sets PrivateLinkServiceResourceId field to given value. + +### HasPrivateLinkServiceResourceId + +`func (o *ServerlessTenantEndpoint) HasPrivateLinkServiceResourceId() bool` + +HasPrivateLinkServiceResourceId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessTenantEndpointCreate.md b/docs/docs/ServerlessTenantEndpointCreate.md new file mode 100644 index 00000000..1566c456 --- /dev/null +++ b/docs/docs/ServerlessTenantEndpointCreate.md @@ -0,0 +1,56 @@ +# ServerlessTenantEndpointCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Human-readable comment associated with the private endpoint. | [optional] + +## Methods + +### NewServerlessTenantEndpointCreate + +`func NewServerlessTenantEndpointCreate() *ServerlessTenantEndpointCreate` + +NewServerlessTenantEndpointCreate instantiates a new ServerlessTenantEndpointCreate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessTenantEndpointCreateWithDefaults + +`func NewServerlessTenantEndpointCreateWithDefaults() *ServerlessTenantEndpointCreate` + +NewServerlessTenantEndpointCreateWithDefaults instantiates a new ServerlessTenantEndpointCreate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetComment + +`func (o *ServerlessTenantEndpointCreate) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ServerlessTenantEndpointCreate) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ServerlessTenantEndpointCreate) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ServerlessTenantEndpointCreate) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ServerlessTenantEndpointUpdate.md b/docs/docs/ServerlessTenantEndpointUpdate.md new file mode 100644 index 00000000..92d79252 --- /dev/null +++ b/docs/docs/ServerlessTenantEndpointUpdate.md @@ -0,0 +1,129 @@ +# ServerlessTenantEndpointUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudProviderEndpointId** | Pointer to **string** | Unique string that identifies the Azure private endpoint's network interface for this private endpoint service. | [optional] +**Comment** | Pointer to **string** | Human-readable comment associated with the private endpoint. | [optional] +**ProviderName** | **string** | | +**PrivateEndpointIpAddress** | Pointer to **string** | IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. | [optional] + +## Methods + +### NewServerlessTenantEndpointUpdate + +`func NewServerlessTenantEndpointUpdate(providerName string, ) *ServerlessTenantEndpointUpdate` + +NewServerlessTenantEndpointUpdate instantiates a new ServerlessTenantEndpointUpdate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerlessTenantEndpointUpdateWithDefaults + +`func NewServerlessTenantEndpointUpdateWithDefaults() *ServerlessTenantEndpointUpdate` + +NewServerlessTenantEndpointUpdateWithDefaults instantiates a new ServerlessTenantEndpointUpdate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCloudProviderEndpointId + +`func (o *ServerlessTenantEndpointUpdate) GetCloudProviderEndpointId() string` + +GetCloudProviderEndpointId returns the CloudProviderEndpointId field if non-nil, zero value otherwise. + +### GetCloudProviderEndpointIdOk + +`func (o *ServerlessTenantEndpointUpdate) GetCloudProviderEndpointIdOk() (*string, bool)` + +GetCloudProviderEndpointIdOk returns a tuple with the CloudProviderEndpointId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudProviderEndpointId + +`func (o *ServerlessTenantEndpointUpdate) SetCloudProviderEndpointId(v string)` + +SetCloudProviderEndpointId sets CloudProviderEndpointId field to given value. + +### HasCloudProviderEndpointId + +`func (o *ServerlessTenantEndpointUpdate) HasCloudProviderEndpointId() bool` + +HasCloudProviderEndpointId returns a boolean if a field has been set. + +### GetComment + +`func (o *ServerlessTenantEndpointUpdate) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ServerlessTenantEndpointUpdate) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ServerlessTenantEndpointUpdate) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ServerlessTenantEndpointUpdate) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetProviderName + +`func (o *ServerlessTenantEndpointUpdate) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *ServerlessTenantEndpointUpdate) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *ServerlessTenantEndpointUpdate) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + + +### GetPrivateEndpointIpAddress + +`func (o *ServerlessTenantEndpointUpdate) GetPrivateEndpointIpAddress() string` + +GetPrivateEndpointIpAddress returns the PrivateEndpointIpAddress field if non-nil, zero value otherwise. + +### GetPrivateEndpointIpAddressOk + +`func (o *ServerlessTenantEndpointUpdate) GetPrivateEndpointIpAddressOk() (*string, bool)` + +GetPrivateEndpointIpAddressOk returns a tuple with the PrivateEndpointIpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateEndpointIpAddress + +`func (o *ServerlessTenantEndpointUpdate) SetPrivateEndpointIpAddress(v string)` + +SetPrivateEndpointIpAddress sets PrivateEndpointIpAddress field to given value. + +### HasPrivateEndpointIpAddress + +`func (o *ServerlessTenantEndpointUpdate) HasPrivateEndpointIpAddress() bool` + +HasPrivateEndpointIpAddress returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SharedTierRestoreJobsApi.md b/docs/docs/SharedTierRestoreJobsApi.md new file mode 100644 index 00000000..48b3e4a3 --- /dev/null +++ b/docs/docs/SharedTierRestoreJobsApi.md @@ -0,0 +1,247 @@ +# \SharedTierRestoreJobsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateSharedClusterBackupRestoreJob**](SharedTierRestoreJobsApi.md#CreateSharedClusterBackupRestoreJob) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore | Create One Restore Job from One M2 or M5 Cluster +[**GetSharedClusterBackupRestoreJob**](SharedTierRestoreJobsApi.md#GetSharedClusterBackupRestoreJob) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId} | Return One Restore Job for One M2 or M5 Cluster +[**ListSharedClusterBackupRestoreJobs**](SharedTierRestoreJobsApi.md#ListSharedClusterBackupRestoreJobs) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores | Return All Restore Jobs for One M2 or M5 Cluster + + + +## CreateSharedClusterBackupRestoreJob + +> TenantRestore CreateSharedClusterBackupRestoreJob(ctx, clusterName, groupId).TenantRestore(tenantRestore).Execute() + +Create One Restore Job from One M2 or M5 Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + clusterName := "clusterName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantRestore := *openapiclient.NewTenantRestore("32b6e34b3d91647abb20e7b8", "TargetDeploymentItemName_example") // TenantRestore | + + resp, r, err := sdk.SharedTierRestoreJobsApi.CreateSharedClusterBackupRestoreJob(context.Background(), clusterName, groupId).TenantRestore(tenantRestore).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SharedTierRestoreJobsApi.CreateSharedClusterBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateSharedClusterBackupRestoreJob`: TenantRestore + fmt.Fprintf(os.Stdout, "Response from `SharedTierRestoreJobsApi.CreateSharedClusterBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSharedClusterBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **tenantRestore** | [**TenantRestore**](TenantRestore.md) | The restore job details. | + +### Return type + +[**TenantRestore**](TenantRestore.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetSharedClusterBackupRestoreJob + +> TenantRestore GetSharedClusterBackupRestoreJob(ctx, clusterName, groupId, restoreId).Execute() + +Return One Restore Job for One M2 or M5 Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + clusterName := "clusterName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + restoreId := "restoreId_example" // string | + + resp, r, err := sdk.SharedTierRestoreJobsApi.GetSharedClusterBackupRestoreJob(context.Background(), clusterName, groupId, restoreId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SharedTierRestoreJobsApi.GetSharedClusterBackupRestoreJob``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetSharedClusterBackupRestoreJob`: TenantRestore + fmt.Fprintf(os.Stdout, "Response from `SharedTierRestoreJobsApi.GetSharedClusterBackupRestoreJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**restoreId** | **string** | Unique 24-hexadecimal digit string that identifies the restore job to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSharedClusterBackupRestoreJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**TenantRestore**](TenantRestore.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListSharedClusterBackupRestoreJobs + +> PaginatedTenantRestore ListSharedClusterBackupRestoreJobs(ctx, clusterName, groupId).Execute() + +Return All Restore Jobs for One M2 or M5 Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + clusterName := "clusterName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.SharedTierRestoreJobsApi.ListSharedClusterBackupRestoreJobs(context.Background(), clusterName, groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SharedTierRestoreJobsApi.ListSharedClusterBackupRestoreJobs``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListSharedClusterBackupRestoreJobs`: PaginatedTenantRestore + fmt.Fprintf(os.Stdout, "Response from `SharedTierRestoreJobsApi.ListSharedClusterBackupRestoreJobs`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSharedClusterBackupRestoreJobsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**PaginatedTenantRestore**](PaginatedTenantRestore.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/SharedTierSnapshotsApi.md b/docs/docs/SharedTierSnapshotsApi.md new file mode 100644 index 00000000..128a8886 --- /dev/null +++ b/docs/docs/SharedTierSnapshotsApi.md @@ -0,0 +1,247 @@ +# \SharedTierSnapshotsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**DownloadSharedClusterBackup**](SharedTierSnapshotsApi.md#DownloadSharedClusterBackup) | **Post** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download | Download One M2 or M5 Cluster Snapshot +[**GetSharedClusterBackup**](SharedTierSnapshotsApi.md#GetSharedClusterBackup) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId} | Return One Snapshot for One M2 or M5 Cluster +[**ListSharedClusterBackups**](SharedTierSnapshotsApi.md#ListSharedClusterBackups) | **Get** /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots | Return All Snapshots for One M2 or M5 Cluster + + + +## DownloadSharedClusterBackup + +> TenantRestore DownloadSharedClusterBackup(ctx, clusterName, groupId).TenantRestore(tenantRestore).Execute() + +Download One M2 or M5 Cluster Snapshot + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + clusterName := "clusterName_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + tenantRestore := *openapiclient.NewTenantRestore("32b6e34b3d91647abb20e7b8", "TargetDeploymentItemName_example") // TenantRestore | + + resp, r, err := sdk.SharedTierSnapshotsApi.DownloadSharedClusterBackup(context.Background(), clusterName, groupId).TenantRestore(tenantRestore).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SharedTierSnapshotsApi.DownloadSharedClusterBackup``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DownloadSharedClusterBackup`: TenantRestore + fmt.Fprintf(os.Stdout, "Response from `SharedTierSnapshotsApi.DownloadSharedClusterBackup`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadSharedClusterBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **tenantRestore** | [**TenantRestore**](TenantRestore.md) | Snapshot to be downloaded. | + +### Return type + +[**TenantRestore**](TenantRestore.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetSharedClusterBackup + +> TenantSnapshot GetSharedClusterBackup(ctx, groupId, clusterName, snapshotId).Execute() + +Return One Snapshot for One M2 or M5 Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + snapshotId := "snapshotId_example" // string | + + resp, r, err := sdk.SharedTierSnapshotsApi.GetSharedClusterBackup(context.Background(), groupId, clusterName, snapshotId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SharedTierSnapshotsApi.GetSharedClusterBackup``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetSharedClusterBackup`: TenantSnapshot + fmt.Fprintf(os.Stdout, "Response from `SharedTierSnapshotsApi.GetSharedClusterBackup`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | +**snapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the desired snapshot. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSharedClusterBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**TenantSnapshot**](TenantSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListSharedClusterBackups + +> PaginatedTenantSnapshot ListSharedClusterBackups(ctx, groupId, clusterName).Execute() + +Return All Snapshots for One M2 or M5 Cluster + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + clusterName := "clusterName_example" // string | + + resp, r, err := sdk.SharedTierSnapshotsApi.ListSharedClusterBackups(context.Background(), groupId, clusterName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SharedTierSnapshotsApi.ListSharedClusterBackups``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListSharedClusterBackups`: PaginatedTenantSnapshot + fmt.Fprintf(os.Stdout, "Response from `SharedTierSnapshotsApi.ListSharedClusterBackups`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**clusterName** | **string** | Human-readable label that identifies the cluster. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSharedClusterBackupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**PaginatedTenantSnapshot**](PaginatedTenantSnapshot.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/Slack.md b/docs/docs/Slack.md new file mode 100644 index 00000000..7f554e0c --- /dev/null +++ b/docs/docs/Slack.md @@ -0,0 +1,134 @@ +# Slack + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiToken** | **string** | Key that allows MongoDB Cloud to access your Slack account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. **IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported. | +**ChannelName** | **NullableString** | Name of the Slack channel to which MongoDB Cloud sends alert notifications. | +**TeamName** | Pointer to **string** | Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration. | [optional] +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] + +## Methods + +### NewSlack + +`func NewSlack(apiToken string, channelName NullableString, ) *Slack` + +NewSlack instantiates a new Slack object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSlackWithDefaults + +`func NewSlackWithDefaults() *Slack` + +NewSlackWithDefaults instantiates a new Slack object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiToken + +`func (o *Slack) GetApiToken() string` + +GetApiToken returns the ApiToken field if non-nil, zero value otherwise. + +### GetApiTokenOk + +`func (o *Slack) GetApiTokenOk() (*string, bool)` + +GetApiTokenOk returns a tuple with the ApiToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiToken + +`func (o *Slack) SetApiToken(v string)` + +SetApiToken sets ApiToken field to given value. + + +### GetChannelName + +`func (o *Slack) GetChannelName() string` + +GetChannelName returns the ChannelName field if non-nil, zero value otherwise. + +### GetChannelNameOk + +`func (o *Slack) GetChannelNameOk() (*string, bool)` + +GetChannelNameOk returns a tuple with the ChannelName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChannelName + +`func (o *Slack) SetChannelName(v string)` + +SetChannelName sets ChannelName field to given value. + + +### SetChannelNameNil + +`func (o *Slack) SetChannelNameNil(b bool)` + + SetChannelNameNil sets the value for ChannelName to be an explicit nil + +### UnsetChannelName +`func (o *Slack) UnsetChannelName()` + +UnsetChannelName ensures that no value is present for ChannelName, not even an explicit nil +### GetTeamName + +`func (o *Slack) GetTeamName() string` + +GetTeamName returns the TeamName field if non-nil, zero value otherwise. + +### GetTeamNameOk + +`func (o *Slack) GetTeamNameOk() (*string, bool)` + +GetTeamNameOk returns a tuple with the TeamName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamName + +`func (o *Slack) SetTeamName(v string)` + +SetTeamName sets TeamName field to given value. + +### HasTeamName + +`func (o *Slack) HasTeamName() bool` + +HasTeamName returns a boolean if a field has been set. + +### GetType + +`func (o *Slack) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Slack) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Slack) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Slack) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SlackNotification.md b/docs/docs/SlackNotification.md new file mode 100644 index 00000000..216256c7 --- /dev/null +++ b/docs/docs/SlackNotification.md @@ -0,0 +1,155 @@ +# SlackNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiToken** | Pointer to **string** | Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**ChannelName** | Pointer to **string** | Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. | [optional] +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewSlackNotification + +`func NewSlackNotification(typeName string, ) *SlackNotification` + +NewSlackNotification instantiates a new SlackNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSlackNotificationWithDefaults + +`func NewSlackNotificationWithDefaults() *SlackNotification` + +NewSlackNotificationWithDefaults instantiates a new SlackNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiToken + +`func (o *SlackNotification) GetApiToken() string` + +GetApiToken returns the ApiToken field if non-nil, zero value otherwise. + +### GetApiTokenOk + +`func (o *SlackNotification) GetApiTokenOk() (*string, bool)` + +GetApiTokenOk returns a tuple with the ApiToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiToken + +`func (o *SlackNotification) SetApiToken(v string)` + +SetApiToken sets ApiToken field to given value. + +### HasApiToken + +`func (o *SlackNotification) HasApiToken() bool` + +HasApiToken returns a boolean if a field has been set. + +### GetChannelName + +`func (o *SlackNotification) GetChannelName() string` + +GetChannelName returns the ChannelName field if non-nil, zero value otherwise. + +### GetChannelNameOk + +`func (o *SlackNotification) GetChannelNameOk() (*string, bool)` + +GetChannelNameOk returns a tuple with the ChannelName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChannelName + +`func (o *SlackNotification) SetChannelName(v string)` + +SetChannelName sets ChannelName field to given value. + +### HasChannelName + +`func (o *SlackNotification) HasChannelName() bool` + +HasChannelName returns a boolean if a field has been set. + +### GetDelayMin + +`func (o *SlackNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *SlackNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *SlackNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *SlackNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *SlackNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *SlackNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *SlackNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *SlackNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *SlackNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *SlackNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *SlackNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Snapshot.md b/docs/docs/Snapshot.md new file mode 100644 index 00000000..df431842 --- /dev/null +++ b/docs/docs/Snapshot.md @@ -0,0 +1,290 @@ +# Snapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return. | [optional] [readonly] +**Complete** | Pointer to **bool** | Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot. | [optional] [readonly] +**Created** | Pointer to [**BSONTimestamp**](BSONTimestamp.md) | | [optional] +**DoNotDelete** | Pointer to **bool** | Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request. | [optional] +**Expires** | Pointer to **time.Time** | Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter. | [optional] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns the snapshots. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the snapshot. | [optional] [readonly] +**LastOplogAppliedTimestamp** | Pointer to [**BSONTimestamp**](BSONTimestamp.md) | | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Parts** | Pointer to [**[]SnapshotPart**](SnapshotPart.md) | Metadata that describes the complete snapshot. - For a replica set, this array contains a single document. - For a sharded cluster, this array contains one document for each shard plus one document for the config host. | [optional] [readonly] + +## Methods + +### NewSnapshot + +`func NewSnapshot() *Snapshot` + +NewSnapshot instantiates a new Snapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSnapshotWithDefaults + +`func NewSnapshotWithDefaults() *Snapshot` + +NewSnapshotWithDefaults instantiates a new Snapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterId + +`func (o *Snapshot) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *Snapshot) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *Snapshot) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + +### HasClusterId + +`func (o *Snapshot) HasClusterId() bool` + +HasClusterId returns a boolean if a field has been set. + +### GetComplete + +`func (o *Snapshot) GetComplete() bool` + +GetComplete returns the Complete field if non-nil, zero value otherwise. + +### GetCompleteOk + +`func (o *Snapshot) GetCompleteOk() (*bool, bool)` + +GetCompleteOk returns a tuple with the Complete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComplete + +`func (o *Snapshot) SetComplete(v bool)` + +SetComplete sets Complete field to given value. + +### HasComplete + +`func (o *Snapshot) HasComplete() bool` + +HasComplete returns a boolean if a field has been set. + +### GetCreated + +`func (o *Snapshot) GetCreated() BSONTimestamp` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Snapshot) GetCreatedOk() (*BSONTimestamp, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Snapshot) SetCreated(v BSONTimestamp)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Snapshot) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetDoNotDelete + +`func (o *Snapshot) GetDoNotDelete() bool` + +GetDoNotDelete returns the DoNotDelete field if non-nil, zero value otherwise. + +### GetDoNotDeleteOk + +`func (o *Snapshot) GetDoNotDeleteOk() (*bool, bool)` + +GetDoNotDeleteOk returns a tuple with the DoNotDelete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDoNotDelete + +`func (o *Snapshot) SetDoNotDelete(v bool)` + +SetDoNotDelete sets DoNotDelete field to given value. + +### HasDoNotDelete + +`func (o *Snapshot) HasDoNotDelete() bool` + +HasDoNotDelete returns a boolean if a field has been set. + +### GetExpires + +`func (o *Snapshot) GetExpires() time.Time` + +GetExpires returns the Expires field if non-nil, zero value otherwise. + +### GetExpiresOk + +`func (o *Snapshot) GetExpiresOk() (*time.Time, bool)` + +GetExpiresOk returns a tuple with the Expires field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpires + +`func (o *Snapshot) SetExpires(v time.Time)` + +SetExpires sets Expires field to given value. + +### HasExpires + +`func (o *Snapshot) HasExpires() bool` + +HasExpires returns a boolean if a field has been set. + +### GetGroupId + +`func (o *Snapshot) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *Snapshot) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *Snapshot) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *Snapshot) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *Snapshot) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Snapshot) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Snapshot) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Snapshot) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLastOplogAppliedTimestamp + +`func (o *Snapshot) GetLastOplogAppliedTimestamp() BSONTimestamp` + +GetLastOplogAppliedTimestamp returns the LastOplogAppliedTimestamp field if non-nil, zero value otherwise. + +### GetLastOplogAppliedTimestampOk + +`func (o *Snapshot) GetLastOplogAppliedTimestampOk() (*BSONTimestamp, bool)` + +GetLastOplogAppliedTimestampOk returns a tuple with the LastOplogAppliedTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastOplogAppliedTimestamp + +`func (o *Snapshot) SetLastOplogAppliedTimestamp(v BSONTimestamp)` + +SetLastOplogAppliedTimestamp sets LastOplogAppliedTimestamp field to given value. + +### HasLastOplogAppliedTimestamp + +`func (o *Snapshot) HasLastOplogAppliedTimestamp() bool` + +HasLastOplogAppliedTimestamp returns a boolean if a field has been set. + +### GetLinks + +`func (o *Snapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Snapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Snapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Snapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetParts + +`func (o *Snapshot) GetParts() []SnapshotPart` + +GetParts returns the Parts field if non-nil, zero value otherwise. + +### GetPartsOk + +`func (o *Snapshot) GetPartsOk() (*[]SnapshotPart, bool)` + +GetPartsOk returns a tuple with the Parts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParts + +`func (o *Snapshot) SetParts(v []SnapshotPart)` + +SetParts sets Parts field to given value. + +### HasParts + +`func (o *Snapshot) HasParts() bool` + +HasParts returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SnapshotPart.md b/docs/docs/SnapshotPart.md new file mode 100644 index 00000000..bafcd9c5 --- /dev/null +++ b/docs/docs/SnapshotPart.md @@ -0,0 +1,290 @@ +# SnapshotPart + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return. | [optional] [readonly] +**CompressionSetting** | Pointer to **string** | Human-readable label that identifies the method of compression for the snapshot. | [optional] [readonly] +**DataSizeBytes** | Pointer to **int64** | Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes. | [optional] [readonly] +**EncryptionEnabled** | Pointer to **bool** | Flag that indicates whether someone encrypted this snapshot. | [optional] [readonly] +**FileSizeBytes** | Pointer to **int64** | Number that indicates the total size of the data files in bytes. | [optional] [readonly] +**MasterKeyUUID** | Pointer to **string** | Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`. | [optional] [readonly] +**MongodVersion** | Pointer to **string** | Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label that identifies the replica set. | [optional] [readonly] +**StorageSizeBytes** | Pointer to **int64** | Number that indicates the total size of space allocated for document storage. | [optional] [readonly] +**TypeName** | Pointer to **string** | Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot. | [optional] [readonly] + +## Methods + +### NewSnapshotPart + +`func NewSnapshotPart() *SnapshotPart` + +NewSnapshotPart instantiates a new SnapshotPart object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSnapshotPartWithDefaults + +`func NewSnapshotPartWithDefaults() *SnapshotPart` + +NewSnapshotPartWithDefaults instantiates a new SnapshotPart object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterId + +`func (o *SnapshotPart) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *SnapshotPart) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *SnapshotPart) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + +### HasClusterId + +`func (o *SnapshotPart) HasClusterId() bool` + +HasClusterId returns a boolean if a field has been set. + +### GetCompressionSetting + +`func (o *SnapshotPart) GetCompressionSetting() string` + +GetCompressionSetting returns the CompressionSetting field if non-nil, zero value otherwise. + +### GetCompressionSettingOk + +`func (o *SnapshotPart) GetCompressionSettingOk() (*string, bool)` + +GetCompressionSettingOk returns a tuple with the CompressionSetting field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompressionSetting + +`func (o *SnapshotPart) SetCompressionSetting(v string)` + +SetCompressionSetting sets CompressionSetting field to given value. + +### HasCompressionSetting + +`func (o *SnapshotPart) HasCompressionSetting() bool` + +HasCompressionSetting returns a boolean if a field has been set. + +### GetDataSizeBytes + +`func (o *SnapshotPart) GetDataSizeBytes() int64` + +GetDataSizeBytes returns the DataSizeBytes field if non-nil, zero value otherwise. + +### GetDataSizeBytesOk + +`func (o *SnapshotPart) GetDataSizeBytesOk() (*int64, bool)` + +GetDataSizeBytesOk returns a tuple with the DataSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSizeBytes + +`func (o *SnapshotPart) SetDataSizeBytes(v int64)` + +SetDataSizeBytes sets DataSizeBytes field to given value. + +### HasDataSizeBytes + +`func (o *SnapshotPart) HasDataSizeBytes() bool` + +HasDataSizeBytes returns a boolean if a field has been set. + +### GetEncryptionEnabled + +`func (o *SnapshotPart) GetEncryptionEnabled() bool` + +GetEncryptionEnabled returns the EncryptionEnabled field if non-nil, zero value otherwise. + +### GetEncryptionEnabledOk + +`func (o *SnapshotPart) GetEncryptionEnabledOk() (*bool, bool)` + +GetEncryptionEnabledOk returns a tuple with the EncryptionEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionEnabled + +`func (o *SnapshotPart) SetEncryptionEnabled(v bool)` + +SetEncryptionEnabled sets EncryptionEnabled field to given value. + +### HasEncryptionEnabled + +`func (o *SnapshotPart) HasEncryptionEnabled() bool` + +HasEncryptionEnabled returns a boolean if a field has been set. + +### GetFileSizeBytes + +`func (o *SnapshotPart) GetFileSizeBytes() int64` + +GetFileSizeBytes returns the FileSizeBytes field if non-nil, zero value otherwise. + +### GetFileSizeBytesOk + +`func (o *SnapshotPart) GetFileSizeBytesOk() (*int64, bool)` + +GetFileSizeBytesOk returns a tuple with the FileSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileSizeBytes + +`func (o *SnapshotPart) SetFileSizeBytes(v int64)` + +SetFileSizeBytes sets FileSizeBytes field to given value. + +### HasFileSizeBytes + +`func (o *SnapshotPart) HasFileSizeBytes() bool` + +HasFileSizeBytes returns a boolean if a field has been set. + +### GetMasterKeyUUID + +`func (o *SnapshotPart) GetMasterKeyUUID() string` + +GetMasterKeyUUID returns the MasterKeyUUID field if non-nil, zero value otherwise. + +### GetMasterKeyUUIDOk + +`func (o *SnapshotPart) GetMasterKeyUUIDOk() (*string, bool)` + +GetMasterKeyUUIDOk returns a tuple with the MasterKeyUUID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMasterKeyUUID + +`func (o *SnapshotPart) SetMasterKeyUUID(v string)` + +SetMasterKeyUUID sets MasterKeyUUID field to given value. + +### HasMasterKeyUUID + +`func (o *SnapshotPart) HasMasterKeyUUID() bool` + +HasMasterKeyUUID returns a boolean if a field has been set. + +### GetMongodVersion + +`func (o *SnapshotPart) GetMongodVersion() string` + +GetMongodVersion returns the MongodVersion field if non-nil, zero value otherwise. + +### GetMongodVersionOk + +`func (o *SnapshotPart) GetMongodVersionOk() (*string, bool)` + +GetMongodVersionOk returns a tuple with the MongodVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongodVersion + +`func (o *SnapshotPart) SetMongodVersion(v string)` + +SetMongodVersion sets MongodVersion field to given value. + +### HasMongodVersion + +`func (o *SnapshotPart) HasMongodVersion() bool` + +HasMongodVersion returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *SnapshotPart) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *SnapshotPart) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *SnapshotPart) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *SnapshotPart) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetStorageSizeBytes + +`func (o *SnapshotPart) GetStorageSizeBytes() int64` + +GetStorageSizeBytes returns the StorageSizeBytes field if non-nil, zero value otherwise. + +### GetStorageSizeBytesOk + +`func (o *SnapshotPart) GetStorageSizeBytesOk() (*int64, bool)` + +GetStorageSizeBytesOk returns a tuple with the StorageSizeBytes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageSizeBytes + +`func (o *SnapshotPart) SetStorageSizeBytes(v int64)` + +SetStorageSizeBytes sets StorageSizeBytes field to given value. + +### HasStorageSizeBytes + +`func (o *SnapshotPart) HasStorageSizeBytes() bool` + +HasStorageSizeBytes returns a boolean if a field has been set. + +### GetTypeName + +`func (o *SnapshotPart) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *SnapshotPart) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *SnapshotPart) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + +### HasTypeName + +`func (o *SnapshotPart) HasTypeName() bool` + +HasTypeName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SnapshotRetention.md b/docs/docs/SnapshotRetention.md new file mode 100644 index 00000000..7b4d1f63 --- /dev/null +++ b/docs/docs/SnapshotRetention.md @@ -0,0 +1,98 @@ +# SnapshotRetention + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**RetentionUnit** | **string** | Quantity of time in which MongoDB Cloud measures snapshot retention. | +**RetentionValue** | **int** | Number that indicates the amount of days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item. | + +## Methods + +### NewSnapshotRetention + +`func NewSnapshotRetention(retentionUnit string, retentionValue int, ) *SnapshotRetention` + +NewSnapshotRetention instantiates a new SnapshotRetention object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSnapshotRetentionWithDefaults + +`func NewSnapshotRetentionWithDefaults() *SnapshotRetention` + +NewSnapshotRetentionWithDefaults instantiates a new SnapshotRetention object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *SnapshotRetention) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *SnapshotRetention) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *SnapshotRetention) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *SnapshotRetention) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetRetentionUnit + +`func (o *SnapshotRetention) GetRetentionUnit() string` + +GetRetentionUnit returns the RetentionUnit field if non-nil, zero value otherwise. + +### GetRetentionUnitOk + +`func (o *SnapshotRetention) GetRetentionUnitOk() (*string, bool)` + +GetRetentionUnitOk returns a tuple with the RetentionUnit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetentionUnit + +`func (o *SnapshotRetention) SetRetentionUnit(v string)` + +SetRetentionUnit sets RetentionUnit field to given value. + + +### GetRetentionValue + +`func (o *SnapshotRetention) GetRetentionValue() int` + +GetRetentionValue returns the RetentionValue field if non-nil, zero value otherwise. + +### GetRetentionValueOk + +`func (o *SnapshotRetention) GetRetentionValueOk() (*int, bool)` + +GetRetentionValueOk returns a tuple with the RetentionValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetentionValue + +`func (o *SnapshotRetention) SetRetentionValue(v int)` + +SetRetentionValue sets RetentionValue field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SnapshotSchedule.md b/docs/docs/SnapshotSchedule.md new file mode 100644 index 00000000..fd296524 --- /dev/null +++ b/docs/docs/SnapshotSchedule.md @@ -0,0 +1,245 @@ +# SnapshotSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterCheckpointIntervalMin** | **int** | Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters. | +**ClusterId** | **string** | Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. | +**DailySnapshotRetentionDays** | **int** | Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention. | +**GroupId** | **string** | Unique 24-hexadecimal digit string that identifies the project that contains the cluster. | [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MonthlySnapshotRetentionMonths** | **int** | Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention. | +**PointInTimeWindowHours** | **int** | Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot. | +**SnapshotIntervalHours** | **int** | Number of hours that must elapse before taking another snapshot. | +**SnapshotRetentionDays** | **int** | Number of days that MongoDB Cloud must keep recent snapshots. | +**WeeklySnapshotRetentionWeeks** | **int** | Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention. | + +## Methods + +### NewSnapshotSchedule + +`func NewSnapshotSchedule(clusterCheckpointIntervalMin int, clusterId string, dailySnapshotRetentionDays int, groupId string, monthlySnapshotRetentionMonths int, pointInTimeWindowHours int, snapshotIntervalHours int, snapshotRetentionDays int, weeklySnapshotRetentionWeeks int, ) *SnapshotSchedule` + +NewSnapshotSchedule instantiates a new SnapshotSchedule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSnapshotScheduleWithDefaults + +`func NewSnapshotScheduleWithDefaults() *SnapshotSchedule` + +NewSnapshotScheduleWithDefaults instantiates a new SnapshotSchedule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterCheckpointIntervalMin + +`func (o *SnapshotSchedule) GetClusterCheckpointIntervalMin() int` + +GetClusterCheckpointIntervalMin returns the ClusterCheckpointIntervalMin field if non-nil, zero value otherwise. + +### GetClusterCheckpointIntervalMinOk + +`func (o *SnapshotSchedule) GetClusterCheckpointIntervalMinOk() (*int, bool)` + +GetClusterCheckpointIntervalMinOk returns a tuple with the ClusterCheckpointIntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterCheckpointIntervalMin + +`func (o *SnapshotSchedule) SetClusterCheckpointIntervalMin(v int)` + +SetClusterCheckpointIntervalMin sets ClusterCheckpointIntervalMin field to given value. + + +### GetClusterId + +`func (o *SnapshotSchedule) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *SnapshotSchedule) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *SnapshotSchedule) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetDailySnapshotRetentionDays + +`func (o *SnapshotSchedule) GetDailySnapshotRetentionDays() int` + +GetDailySnapshotRetentionDays returns the DailySnapshotRetentionDays field if non-nil, zero value otherwise. + +### GetDailySnapshotRetentionDaysOk + +`func (o *SnapshotSchedule) GetDailySnapshotRetentionDaysOk() (*int, bool)` + +GetDailySnapshotRetentionDaysOk returns a tuple with the DailySnapshotRetentionDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDailySnapshotRetentionDays + +`func (o *SnapshotSchedule) SetDailySnapshotRetentionDays(v int)` + +SetDailySnapshotRetentionDays sets DailySnapshotRetentionDays field to given value. + + +### GetGroupId + +`func (o *SnapshotSchedule) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *SnapshotSchedule) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *SnapshotSchedule) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + + +### GetLinks + +`func (o *SnapshotSchedule) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *SnapshotSchedule) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *SnapshotSchedule) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *SnapshotSchedule) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMonthlySnapshotRetentionMonths + +`func (o *SnapshotSchedule) GetMonthlySnapshotRetentionMonths() int` + +GetMonthlySnapshotRetentionMonths returns the MonthlySnapshotRetentionMonths field if non-nil, zero value otherwise. + +### GetMonthlySnapshotRetentionMonthsOk + +`func (o *SnapshotSchedule) GetMonthlySnapshotRetentionMonthsOk() (*int, bool)` + +GetMonthlySnapshotRetentionMonthsOk returns a tuple with the MonthlySnapshotRetentionMonths field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonthlySnapshotRetentionMonths + +`func (o *SnapshotSchedule) SetMonthlySnapshotRetentionMonths(v int)` + +SetMonthlySnapshotRetentionMonths sets MonthlySnapshotRetentionMonths field to given value. + + +### GetPointInTimeWindowHours + +`func (o *SnapshotSchedule) GetPointInTimeWindowHours() int` + +GetPointInTimeWindowHours returns the PointInTimeWindowHours field if non-nil, zero value otherwise. + +### GetPointInTimeWindowHoursOk + +`func (o *SnapshotSchedule) GetPointInTimeWindowHoursOk() (*int, bool)` + +GetPointInTimeWindowHoursOk returns a tuple with the PointInTimeWindowHours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPointInTimeWindowHours + +`func (o *SnapshotSchedule) SetPointInTimeWindowHours(v int)` + +SetPointInTimeWindowHours sets PointInTimeWindowHours field to given value. + + +### GetSnapshotIntervalHours + +`func (o *SnapshotSchedule) GetSnapshotIntervalHours() int` + +GetSnapshotIntervalHours returns the SnapshotIntervalHours field if non-nil, zero value otherwise. + +### GetSnapshotIntervalHoursOk + +`func (o *SnapshotSchedule) GetSnapshotIntervalHoursOk() (*int, bool)` + +GetSnapshotIntervalHoursOk returns a tuple with the SnapshotIntervalHours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotIntervalHours + +`func (o *SnapshotSchedule) SetSnapshotIntervalHours(v int)` + +SetSnapshotIntervalHours sets SnapshotIntervalHours field to given value. + + +### GetSnapshotRetentionDays + +`func (o *SnapshotSchedule) GetSnapshotRetentionDays() int` + +GetSnapshotRetentionDays returns the SnapshotRetentionDays field if non-nil, zero value otherwise. + +### GetSnapshotRetentionDaysOk + +`func (o *SnapshotSchedule) GetSnapshotRetentionDaysOk() (*int, bool)` + +GetSnapshotRetentionDaysOk returns a tuple with the SnapshotRetentionDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotRetentionDays + +`func (o *SnapshotSchedule) SetSnapshotRetentionDays(v int)` + +SetSnapshotRetentionDays sets SnapshotRetentionDays field to given value. + + +### GetWeeklySnapshotRetentionWeeks + +`func (o *SnapshotSchedule) GetWeeklySnapshotRetentionWeeks() int` + +GetWeeklySnapshotRetentionWeeks returns the WeeklySnapshotRetentionWeeks field if non-nil, zero value otherwise. + +### GetWeeklySnapshotRetentionWeeksOk + +`func (o *SnapshotSchedule) GetWeeklySnapshotRetentionWeeksOk() (*int, bool)` + +GetWeeklySnapshotRetentionWeeksOk returns a tuple with the WeeklySnapshotRetentionWeeks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWeeklySnapshotRetentionWeeks + +`func (o *SnapshotSchedule) SetWeeklySnapshotRetentionWeeks(v int)` + +SetWeeklySnapshotRetentionWeeks sets WeeklySnapshotRetentionWeeks field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Source.md b/docs/docs/Source.md new file mode 100644 index 00000000..581ee436 --- /dev/null +++ b/docs/docs/Source.md @@ -0,0 +1,192 @@ +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CaCertificatePath** | Pointer to **string** | Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster. | [optional] +**ClusterName** | **string** | Label that identifies the source cluster name. | +**GroupId** | **string** | Unique 24-hexadecimal digit string that identifies the source project. | +**ManagedAuthentication** | **bool** | Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password. | +**Password** | Pointer to **string** | Password that authenticates the username to the source cluster. | [optional] +**Ssl** | **bool** | Flag that indicates whether you have SSL enabled. | +**Username** | Pointer to **string** | Label that identifies the SCRAM-SHA user that connects to the source cluster. | [optional] + +## Methods + +### NewSource + +`func NewSource(clusterName string, groupId string, managedAuthentication bool, ssl bool, ) *Source` + +NewSource instantiates a new Source object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSourceWithDefaults + +`func NewSourceWithDefaults() *Source` + +NewSourceWithDefaults instantiates a new Source object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCaCertificatePath + +`func (o *Source) GetCaCertificatePath() string` + +GetCaCertificatePath returns the CaCertificatePath field if non-nil, zero value otherwise. + +### GetCaCertificatePathOk + +`func (o *Source) GetCaCertificatePathOk() (*string, bool)` + +GetCaCertificatePathOk returns a tuple with the CaCertificatePath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCaCertificatePath + +`func (o *Source) SetCaCertificatePath(v string)` + +SetCaCertificatePath sets CaCertificatePath field to given value. + +### HasCaCertificatePath + +`func (o *Source) HasCaCertificatePath() bool` + +HasCaCertificatePath returns a boolean if a field has been set. + +### GetClusterName + +`func (o *Source) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *Source) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *Source) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + + +### GetGroupId + +`func (o *Source) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *Source) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *Source) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + + +### GetManagedAuthentication + +`func (o *Source) GetManagedAuthentication() bool` + +GetManagedAuthentication returns the ManagedAuthentication field if non-nil, zero value otherwise. + +### GetManagedAuthenticationOk + +`func (o *Source) GetManagedAuthenticationOk() (*bool, bool)` + +GetManagedAuthenticationOk returns a tuple with the ManagedAuthentication field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedAuthentication + +`func (o *Source) SetManagedAuthentication(v bool)` + +SetManagedAuthentication sets ManagedAuthentication field to given value. + + +### GetPassword + +`func (o *Source) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *Source) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *Source) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *Source) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetSsl + +`func (o *Source) GetSsl() bool` + +GetSsl returns the Ssl field if non-nil, zero value otherwise. + +### GetSslOk + +`func (o *Source) GetSslOk() (*bool, bool)` + +GetSslOk returns a tuple with the Ssl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSsl + +`func (o *Source) SetSsl(v bool)` + +SetSsl sets Ssl field to given value. + + +### GetUsername + +`func (o *Source) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *Source) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *Source) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *Source) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SummaryNotification.md b/docs/docs/SummaryNotification.md new file mode 100644 index 00000000..03eacf10 --- /dev/null +++ b/docs/docs/SummaryNotification.md @@ -0,0 +1,129 @@ +# SummaryNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**EmailAddress** | Pointer to **string** | Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don’t need to set this value to send emails to individual or groups of MongoDB Cloud users including: - specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`) - MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`) - MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`) - MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`) To send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewSummaryNotification + +`func NewSummaryNotification(typeName string, ) *SummaryNotification` + +NewSummaryNotification instantiates a new SummaryNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSummaryNotificationWithDefaults + +`func NewSummaryNotificationWithDefaults() *SummaryNotification` + +NewSummaryNotificationWithDefaults instantiates a new SummaryNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *SummaryNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *SummaryNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *SummaryNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *SummaryNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *SummaryNotification) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *SummaryNotification) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *SummaryNotification) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *SummaryNotification) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *SummaryNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *SummaryNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *SummaryNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *SummaryNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *SummaryNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *SummaryNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *SummaryNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SynonymSource.md b/docs/docs/SynonymSource.md new file mode 100644 index 00000000..47693fd3 --- /dev/null +++ b/docs/docs/SynonymSource.md @@ -0,0 +1,51 @@ +# SynonymSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Collection** | **string** | Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms. | + +## Methods + +### NewSynonymSource + +`func NewSynonymSource(collection string, ) *SynonymSource` + +NewSynonymSource instantiates a new SynonymSource object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSynonymSourceWithDefaults + +`func NewSynonymSourceWithDefaults() *SynonymSource` + +NewSynonymSourceWithDefaults instantiates a new SynonymSource object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCollection + +`func (o *SynonymSource) GetCollection() string` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *SynonymSource) GetCollectionOk() (*string, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCollection + +`func (o *SynonymSource) SetCollection(v string)` + +SetCollection sets Collection field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/SystemStatus.md b/docs/docs/SystemStatus.md new file mode 100644 index 00000000..0a8f9334 --- /dev/null +++ b/docs/docs/SystemStatus.md @@ -0,0 +1,150 @@ +# SystemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | [**NullableKey**](Key.md) | | +**AppName** | **string** | Human-readable label that identifies the service from which you requested this response. | [readonly] +**Build** | **string** | Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application. | [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Throttling** | **bool** | Flag that indicates whether someone enabled throttling on this service. | [readonly] + +## Methods + +### NewSystemStatus + +`func NewSystemStatus(apiKey NullableKey, appName string, build string, throttling bool, ) *SystemStatus` + +NewSystemStatus instantiates a new SystemStatus object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSystemStatusWithDefaults + +`func NewSystemStatusWithDefaults() *SystemStatus` + +NewSystemStatusWithDefaults instantiates a new SystemStatus object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKey + +`func (o *SystemStatus) GetApiKey() Key` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *SystemStatus) GetApiKeyOk() (*Key, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *SystemStatus) SetApiKey(v Key)` + +SetApiKey sets ApiKey field to given value. + + +### SetApiKeyNil + +`func (o *SystemStatus) SetApiKeyNil(b bool)` + + SetApiKeyNil sets the value for ApiKey to be an explicit nil + +### UnsetApiKey +`func (o *SystemStatus) UnsetApiKey()` + +UnsetApiKey ensures that no value is present for ApiKey, not even an explicit nil +### GetAppName + +`func (o *SystemStatus) GetAppName() string` + +GetAppName returns the AppName field if non-nil, zero value otherwise. + +### GetAppNameOk + +`func (o *SystemStatus) GetAppNameOk() (*string, bool)` + +GetAppNameOk returns a tuple with the AppName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppName + +`func (o *SystemStatus) SetAppName(v string)` + +SetAppName sets AppName field to given value. + + +### GetBuild + +`func (o *SystemStatus) GetBuild() string` + +GetBuild returns the Build field if non-nil, zero value otherwise. + +### GetBuildOk + +`func (o *SystemStatus) GetBuildOk() (*string, bool)` + +GetBuildOk returns a tuple with the Build field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBuild + +`func (o *SystemStatus) SetBuild(v string)` + +SetBuild sets Build field to given value. + + +### GetLinks + +`func (o *SystemStatus) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *SystemStatus) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *SystemStatus) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *SystemStatus) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetThrottling + +`func (o *SystemStatus) GetThrottling() bool` + +GetThrottling returns the Throttling field if non-nil, zero value otherwise. + +### GetThrottlingOk + +`func (o *SystemStatus) GetThrottlingOk() (*bool, bool)` + +GetThrottlingOk returns a tuple with the Throttling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThrottling + +`func (o *SystemStatus) SetThrottling(v bool)` + +SetThrottling sets Throttling field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TargetOrg.md b/docs/docs/TargetOrg.md new file mode 100644 index 00000000..e49a2620 --- /dev/null +++ b/docs/docs/TargetOrg.md @@ -0,0 +1,51 @@ +# TargetOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LinkToken** | **string** | Link token that contains all the information required to complete the link. | + +## Methods + +### NewTargetOrg + +`func NewTargetOrg(linkToken string, ) *TargetOrg` + +NewTargetOrg instantiates a new TargetOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTargetOrgWithDefaults + +`func NewTargetOrgWithDefaults() *TargetOrg` + +NewTargetOrgWithDefaults instantiates a new TargetOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinkToken + +`func (o *TargetOrg) GetLinkToken() string` + +GetLinkToken returns the LinkToken field if non-nil, zero value otherwise. + +### GetLinkTokenOk + +`func (o *TargetOrg) GetLinkTokenOk() (*string, bool)` + +GetLinkTokenOk returns a tuple with the LinkToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinkToken + +`func (o *TargetOrg) SetLinkToken(v string)` + +SetLinkToken sets LinkToken field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TargetOrgRequest.md b/docs/docs/TargetOrgRequest.md new file mode 100644 index 00000000..08b81982 --- /dev/null +++ b/docs/docs/TargetOrgRequest.md @@ -0,0 +1,56 @@ +# TargetOrgRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessListIps** | Pointer to **[]string** | IP address access list entries associated with the API key. | [optional] + +## Methods + +### NewTargetOrgRequest + +`func NewTargetOrgRequest() *TargetOrgRequest` + +NewTargetOrgRequest instantiates a new TargetOrgRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTargetOrgRequestWithDefaults + +`func NewTargetOrgRequestWithDefaults() *TargetOrgRequest` + +NewTargetOrgRequestWithDefaults instantiates a new TargetOrgRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAccessListIps + +`func (o *TargetOrgRequest) GetAccessListIps() []string` + +GetAccessListIps returns the AccessListIps field if non-nil, zero value otherwise. + +### GetAccessListIpsOk + +`func (o *TargetOrgRequest) GetAccessListIpsOk() (*[]string, bool)` + +GetAccessListIpsOk returns a tuple with the AccessListIps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessListIps + +`func (o *TargetOrgRequest) SetAccessListIps(v []string)` + +SetAccessListIps sets AccessListIps field to given value. + +### HasAccessListIps + +`func (o *TargetOrgRequest) HasAccessListIps() bool` + +HasAccessListIps returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Team.md b/docs/docs/Team.md new file mode 100644 index 00000000..c9ccd4e4 --- /dev/null +++ b/docs/docs/Team.md @@ -0,0 +1,124 @@ +# Team + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this team. | [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Name** | **string** | Human-readable label that identifies the team. | +**Usernames** | Pointer to **[]string** | List that contains the MongoDB Cloud users in this team. | [optional] + +## Methods + +### NewTeam + +`func NewTeam(id string, name string, ) *Team` + +NewTeam instantiates a new Team object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTeamWithDefaults + +`func NewTeamWithDefaults() *Team` + +NewTeamWithDefaults instantiates a new Team object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *Team) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Team) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Team) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLinks + +`func (o *Team) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *Team) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *Team) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *Team) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetName + +`func (o *Team) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Team) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Team) SetName(v string)` + +SetName sets Name field to given value. + + +### GetUsernames + +`func (o *Team) GetUsernames() []string` + +GetUsernames returns the Usernames field if non-nil, zero value otherwise. + +### GetUsernamesOk + +`func (o *Team) GetUsernamesOk() (*[]string, bool)` + +GetUsernamesOk returns a tuple with the Usernames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernames + +`func (o *Team) SetUsernames(v []string)` + +SetUsernames sets Usernames field to given value. + +### HasUsernames + +`func (o *Team) HasUsernames() bool` + +HasUsernames returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamEvent.md b/docs/docs/TeamEvent.md new file mode 100644 index 00000000..19648320 --- /dev/null +++ b/docs/docs/TeamEvent.md @@ -0,0 +1,379 @@ +# TeamEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**TeamEventType**](TeamEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization team associated with this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewTeamEvent + +`func NewTeamEvent(created time.Time, eventTypeName TeamEventType, id string, ) *TeamEvent` + +NewTeamEvent instantiates a new TeamEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTeamEventWithDefaults + +`func NewTeamEventWithDefaults() *TeamEvent` + +NewTeamEventWithDefaults instantiates a new TeamEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *TeamEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *TeamEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *TeamEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *TeamEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *TeamEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TeamEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TeamEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *TeamEvent) GetEventTypeName() TeamEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *TeamEvent) GetEventTypeNameOk() (*TeamEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *TeamEvent) SetEventTypeName(v TeamEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *TeamEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *TeamEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *TeamEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *TeamEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *TeamEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TeamEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TeamEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *TeamEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *TeamEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *TeamEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *TeamEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *TeamEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TeamEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TeamEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TeamEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *TeamEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *TeamEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *TeamEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *TeamEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *TeamEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *TeamEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *TeamEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *TeamEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *TeamEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *TeamEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *TeamEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *TeamEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *TeamEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *TeamEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *TeamEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *TeamEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetTeamId + +`func (o *TeamEvent) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *TeamEvent) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *TeamEvent) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *TeamEvent) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + +### GetUserId + +`func (o *TeamEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *TeamEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *TeamEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *TeamEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *TeamEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *TeamEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *TeamEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *TeamEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamEventType.md b/docs/docs/TeamEventType.md new file mode 100644 index 00000000..71a53444 --- /dev/null +++ b/docs/docs/TeamEventType.md @@ -0,0 +1,23 @@ +# TeamEventType + +## Enum + + +* `CREATED` (value: `"TEAM_CREATED"`) + +* `DELETED` (value: `"TEAM_DELETED"`) + +* `UPDATED` (value: `"TEAM_UPDATED"`) + +* `NAME_CHANGED` (value: `"TEAM_NAME_CHANGED"`) + +* `ADDED_TO_GROUP` (value: `"TEAM_ADDED_TO_GROUP"`) + +* `REMOVED_FROM_GROUP` (value: `"TEAM_REMOVED_FROM_GROUP"`) + +* `ROLES_MODIFIED` (value: `"TEAM_ROLES_MODIFIED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamEventTypeViewForNdsGroup.md b/docs/docs/TeamEventTypeViewForNdsGroup.md new file mode 100644 index 00000000..6c62f006 --- /dev/null +++ b/docs/docs/TeamEventTypeViewForNdsGroup.md @@ -0,0 +1,15 @@ +# TeamEventTypeViewForNdsGroup + +## Enum + + +* `ADDED_TO_GROUP` (value: `"TEAM_ADDED_TO_GROUP"`) + +* `REMOVED_FROM_GROUP` (value: `"TEAM_REMOVED_FROM_GROUP"`) + +* `ROLES_MODIFIED` (value: `"TEAM_ROLES_MODIFIED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamEventViewForNdsGroup.md b/docs/docs/TeamEventViewForNdsGroup.md new file mode 100644 index 00000000..cac4b9c2 --- /dev/null +++ b/docs/docs/TeamEventViewForNdsGroup.md @@ -0,0 +1,379 @@ +# TeamEventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**TeamEventTypeViewForNdsGroup**](TeamEventTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization team associated with this event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewTeamEventViewForNdsGroup + +`func NewTeamEventViewForNdsGroup(created time.Time, eventTypeName TeamEventTypeViewForNdsGroup, id string, ) *TeamEventViewForNdsGroup` + +NewTeamEventViewForNdsGroup instantiates a new TeamEventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTeamEventViewForNdsGroupWithDefaults + +`func NewTeamEventViewForNdsGroupWithDefaults() *TeamEventViewForNdsGroup` + +NewTeamEventViewForNdsGroupWithDefaults instantiates a new TeamEventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *TeamEventViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *TeamEventViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *TeamEventViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *TeamEventViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *TeamEventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TeamEventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TeamEventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *TeamEventViewForNdsGroup) GetEventTypeName() TeamEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *TeamEventViewForNdsGroup) GetEventTypeNameOk() (*TeamEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *TeamEventViewForNdsGroup) SetEventTypeName(v TeamEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *TeamEventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *TeamEventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *TeamEventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *TeamEventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *TeamEventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TeamEventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TeamEventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *TeamEventViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *TeamEventViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *TeamEventViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *TeamEventViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *TeamEventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TeamEventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TeamEventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TeamEventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *TeamEventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *TeamEventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *TeamEventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *TeamEventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *TeamEventViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *TeamEventViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *TeamEventViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *TeamEventViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *TeamEventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *TeamEventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *TeamEventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *TeamEventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *TeamEventViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *TeamEventViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *TeamEventViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *TeamEventViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetTeamId + +`func (o *TeamEventViewForNdsGroup) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *TeamEventViewForNdsGroup) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *TeamEventViewForNdsGroup) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *TeamEventViewForNdsGroup) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + +### GetUserId + +`func (o *TeamEventViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *TeamEventViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *TeamEventViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *TeamEventViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *TeamEventViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *TeamEventViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *TeamEventViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *TeamEventViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamNotification.md b/docs/docs/TeamNotification.md new file mode 100644 index 00000000..e607f838 --- /dev/null +++ b/docs/docs/TeamNotification.md @@ -0,0 +1,207 @@ +# TeamNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**EmailEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**SmsEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`. | [optional] +**TeamName** | Pointer to **string** | Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | + +## Methods + +### NewTeamNotification + +`func NewTeamNotification(typeName string, ) *TeamNotification` + +NewTeamNotification instantiates a new TeamNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTeamNotificationWithDefaults + +`func NewTeamNotificationWithDefaults() *TeamNotification` + +NewTeamNotificationWithDefaults instantiates a new TeamNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *TeamNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *TeamNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *TeamNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *TeamNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetEmailEnabled + +`func (o *TeamNotification) GetEmailEnabled() bool` + +GetEmailEnabled returns the EmailEnabled field if non-nil, zero value otherwise. + +### GetEmailEnabledOk + +`func (o *TeamNotification) GetEmailEnabledOk() (*bool, bool)` + +GetEmailEnabledOk returns a tuple with the EmailEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEnabled + +`func (o *TeamNotification) SetEmailEnabled(v bool)` + +SetEmailEnabled sets EmailEnabled field to given value. + +### HasEmailEnabled + +`func (o *TeamNotification) HasEmailEnabled() bool` + +HasEmailEnabled returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *TeamNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *TeamNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *TeamNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *TeamNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetSmsEnabled + +`func (o *TeamNotification) GetSmsEnabled() bool` + +GetSmsEnabled returns the SmsEnabled field if non-nil, zero value otherwise. + +### GetSmsEnabledOk + +`func (o *TeamNotification) GetSmsEnabledOk() (*bool, bool)` + +GetSmsEnabledOk returns a tuple with the SmsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSmsEnabled + +`func (o *TeamNotification) SetSmsEnabled(v bool)` + +SetSmsEnabled sets SmsEnabled field to given value. + +### HasSmsEnabled + +`func (o *TeamNotification) HasSmsEnabled() bool` + +HasSmsEnabled returns a boolean if a field has been set. + +### GetTeamId + +`func (o *TeamNotification) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *TeamNotification) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *TeamNotification) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *TeamNotification) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + +### GetTeamName + +`func (o *TeamNotification) GetTeamName() string` + +GetTeamName returns the TeamName field if non-nil, zero value otherwise. + +### GetTeamNameOk + +`func (o *TeamNotification) GetTeamNameOk() (*string, bool)` + +GetTeamNameOk returns a tuple with the TeamName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamName + +`func (o *TeamNotification) SetTeamName(v string)` + +SetTeamName sets TeamName field to given value. + +### HasTeamName + +`func (o *TeamNotification) HasTeamName() bool` + +HasTeamName returns a boolean if a field has been set. + +### GetTypeName + +`func (o *TeamNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *TeamNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *TeamNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamResponse.md b/docs/docs/TeamResponse.md new file mode 100644 index 00000000..95d403f4 --- /dev/null +++ b/docs/docs/TeamResponse.md @@ -0,0 +1,108 @@ +# TeamResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies this team. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**Name** | Pointer to **string** | Human-readable label that identifies the team. | [optional] + +## Methods + +### NewTeamResponse + +`func NewTeamResponse() *TeamResponse` + +NewTeamResponse instantiates a new TeamResponse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTeamResponseWithDefaults + +`func NewTeamResponseWithDefaults() *TeamResponse` + +NewTeamResponseWithDefaults instantiates a new TeamResponse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *TeamResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TeamResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TeamResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TeamResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *TeamResponse) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TeamResponse) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TeamResponse) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TeamResponse) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetName + +`func (o *TeamResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TeamResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TeamResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TeamResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamRole.md b/docs/docs/TeamRole.md new file mode 100644 index 00000000..f0eb7931 --- /dev/null +++ b/docs/docs/TeamRole.md @@ -0,0 +1,108 @@ +# TeamRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**RoleNames** | Pointer to **[]string** | One or more organization- or project-level roles to assign to the MongoDB Cloud user. | [optional] +**TeamId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the team. | [optional] + +## Methods + +### NewTeamRole + +`func NewTeamRole() *TeamRole` + +NewTeamRole instantiates a new TeamRole object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTeamRoleWithDefaults + +`func NewTeamRoleWithDefaults() *TeamRole` + +NewTeamRoleWithDefaults instantiates a new TeamRole object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinks + +`func (o *TeamRole) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TeamRole) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TeamRole) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TeamRole) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetRoleNames + +`func (o *TeamRole) GetRoleNames() []string` + +GetRoleNames returns the RoleNames field if non-nil, zero value otherwise. + +### GetRoleNamesOk + +`func (o *TeamRole) GetRoleNamesOk() (*[]string, bool)` + +GetRoleNamesOk returns a tuple with the RoleNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleNames + +`func (o *TeamRole) SetRoleNames(v []string)` + +SetRoleNames sets RoleNames field to given value. + +### HasRoleNames + +`func (o *TeamRole) HasRoleNames() bool` + +HasRoleNames returns a boolean if a field has been set. + +### GetTeamId + +`func (o *TeamRole) GetTeamId() string` + +GetTeamId returns the TeamId field if non-nil, zero value otherwise. + +### GetTeamIdOk + +`func (o *TeamRole) GetTeamIdOk() (*string, bool)` + +GetTeamIdOk returns a tuple with the TeamId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamId + +`func (o *TeamRole) SetTeamId(v string)` + +SetTeamId sets TeamId field to given value. + +### HasTeamId + +`func (o *TeamRole) HasTeamId() bool` + +HasTeamId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TeamsApi.md b/docs/docs/TeamsApi.md new file mode 100644 index 00000000..84d38d3a --- /dev/null +++ b/docs/docs/TeamsApi.md @@ -0,0 +1,1033 @@ +# \TeamsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AddAllTeamsToProject**](TeamsApi.md#AddAllTeamsToProject) | **Post** /api/atlas/v2/groups/{groupId}/teams | Add One or More Teams to One Project +[**AddTeamUser**](TeamsApi.md#AddTeamUser) | **Post** /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users | Assign MongoDB Cloud Users from One Organization to One Team +[**CreateTeam**](TeamsApi.md#CreateTeam) | **Post** /api/atlas/v2/orgs/{orgId}/teams | Create One Team in One Organization +[**DeleteTeam**](TeamsApi.md#DeleteTeam) | **Delete** /api/atlas/v2/orgs/{orgId}/teams/{teamId} | Remove One Team from One Organization +[**GetTeamById**](TeamsApi.md#GetTeamById) | **Get** /api/atlas/v2/orgs/{orgId}/teams/{teamId} | Return One Team using its ID +[**GetTeamByName**](TeamsApi.md#GetTeamByName) | **Get** /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName} | Return One Team using its Name +[**ListOrganizationTeams**](TeamsApi.md#ListOrganizationTeams) | **Get** /api/atlas/v2/orgs/{orgId}/teams | Return All Teams in One Organization +[**ListProjectTeams**](TeamsApi.md#ListProjectTeams) | **Get** /api/atlas/v2/groups/{groupId}/teams | Return All Teams in One Project +[**ListTeamUsers**](TeamsApi.md#ListTeamUsers) | **Get** /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users | Return All MongoDB Cloud Users Assigned to One Team +[**RemoveProjectTeam**](TeamsApi.md#RemoveProjectTeam) | **Delete** /api/atlas/v2/groups/{groupId}/teams/{teamId} | Remove One Team from One Project +[**RemoveTeamUser**](TeamsApi.md#RemoveTeamUser) | **Delete** /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId} | Remove One MongoDB Cloud User from One Team +[**RenameTeam**](TeamsApi.md#RenameTeam) | **Patch** /api/atlas/v2/orgs/{orgId}/teams/{teamId} | Rename One Team +[**UpdateTeamRoles**](TeamsApi.md#UpdateTeamRoles) | **Patch** /api/atlas/v2/groups/{groupId}/teams/{teamId} | Update Team Roles in One Project + + + +## AddAllTeamsToProject + +> PaginatedTeamRole AddAllTeamsToProject(ctx, groupId).TeamRole(teamRole).Execute() + +Add One or More Teams to One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + teamRole := []openapiclient.TeamRole{*openapiclient.NewTeamRole()} // []TeamRole | + + resp, r, err := sdk.TeamsApi.AddAllTeamsToProject(context.Background(), groupId).TeamRole(teamRole).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.AddAllTeamsToProject``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `AddAllTeamsToProject`: PaginatedTeamRole + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.AddAllTeamsToProject`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAllTeamsToProjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **teamRole** | [**[]TeamRole**](TeamRole.md) | Team to add to the specified project. | + +### Return type + +[**PaginatedTeamRole**](PaginatedTeamRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## AddTeamUser + +> PaginatedApiAppUser AddTeamUser(ctx, orgId, teamId).AddUserToTeam(addUserToTeam).Execute() + +Assign MongoDB Cloud Users from One Organization to One Team + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + teamId := "teamId_example" // string | + addUserToTeam := []openapiclient.AddUserToTeam{*openapiclient.NewAddUserToTeam("32b6e34b3d91647abb20e7b8")} // []AddUserToTeam | + + resp, r, err := sdk.TeamsApi.AddTeamUser(context.Background(), orgId, teamId).AddUserToTeam(addUserToTeam).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.AddTeamUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `AddTeamUser`: PaginatedApiAppUser + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.AddTeamUser`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**teamId** | **string** | Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddTeamUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **addUserToTeam** | [**[]AddUserToTeam**](AddUserToTeam.md) | One or more MongoDB Cloud users that you want to add to the specified team. | + +### Return type + +[**PaginatedApiAppUser**](PaginatedApiAppUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateTeam + +> Team CreateTeam(ctx, orgId).Team(team).Execute() + +Create One Team in One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + team := *openapiclient.NewTeam("32b6e34b3d91647abb20e7b8", "Name_example") // Team | + + resp, r, err := sdk.TeamsApi.CreateTeam(context.Background(), orgId).Team(team).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.CreateTeam``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateTeam`: Team + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.CreateTeam`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateTeamRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **team** | [**Team**](Team.md) | Team that you want to create in the specified organization. | + +### Return type + +[**Team**](Team.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteTeam + +> DeleteTeam(ctx, orgId, teamId).Execute() + +Remove One Team from One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + teamId := "teamId_example" // string | + + r, err := sdk.TeamsApi.DeleteTeam(context.Background(), orgId, teamId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.DeleteTeam``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**teamId** | **string** | Unique 24-hexadecimal digit string that identifies the team that you want to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTeamRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetTeamById + +> TeamResponse GetTeamById(ctx, orgId, teamId).Execute() + +Return One Team using its ID + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + teamId := "teamId_example" // string | + + resp, r, err := sdk.TeamsApi.GetTeamById(context.Background(), orgId, teamId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.GetTeamById``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetTeamById`: TeamResponse + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.GetTeamById`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**teamId** | **string** | Unique 24-hexadecimal digit string that identifies the team whose information you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTeamByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TeamResponse**](TeamResponse.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetTeamByName + +> TeamResponse GetTeamByName(ctx, orgId, teamName).Execute() + +Return One Team using its Name + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + teamName := "teamName_example" // string | + + resp, r, err := sdk.TeamsApi.GetTeamByName(context.Background(), orgId, teamName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.GetTeamByName``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetTeamByName`: TeamResponse + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.GetTeamByName`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**teamName** | **string** | Name of the team whose information you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTeamByNameRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TeamResponse**](TeamResponse.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListOrganizationTeams + +> PaginatedTeam ListOrganizationTeams(ctx, orgId).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).PageNum(pageNum).Execute() + +Return All Teams in One Organization + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + itemsPerPage := int(100) // int | (optional) (default to 100) + includeCount := true // bool | (optional) (default to true) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.TeamsApi.ListOrganizationTeams(context.Background(), orgId).ItemsPerPage(itemsPerPage).IncludeCount(includeCount).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ListOrganizationTeams``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListOrganizationTeams`: PaginatedTeam + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ListOrganizationTeams`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOrganizationTeamsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedTeam**](PaginatedTeam.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListProjectTeams + +> PaginatedTeamRole ListProjectTeams(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Teams in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.TeamsApi.ListProjectTeams(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ListProjectTeams``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListProjectTeams`: PaginatedTeamRole + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ListProjectTeams`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProjectTeamsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedTeamRole**](PaginatedTeamRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListTeamUsers + +> PaginatedApiAppUser ListTeamUsers(ctx, orgId, teamId).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All MongoDB Cloud Users Assigned to One Team + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + teamId := "teamId_example" // string | + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.TeamsApi.ListTeamUsers(context.Background(), orgId, teamId).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.ListTeamUsers``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListTeamUsers`: PaginatedApiAppUser + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.ListTeamUsers`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**teamId** | **string** | Unique 24-hexadecimal digit string that identifies the team whose application users you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTeamUsersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedApiAppUser**](PaginatedApiAppUser.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RemoveProjectTeam + +> RemoveProjectTeam(ctx, groupId, teamId).Execute() + +Remove One Team from One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + teamId := "teamId_example" // string | + + r, err := sdk.TeamsApi.RemoveProjectTeam(context.Background(), groupId, teamId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RemoveProjectTeam``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**teamId** | **string** | Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRemoveProjectTeamRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RemoveTeamUser + +> RemoveTeamUser(ctx, orgId, teamId, userId).Execute() + +Remove One MongoDB Cloud User from One Team + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + teamId := "teamId_example" // string | + userId := "userId_example" // string | + + r, err := sdk.TeamsApi.RemoveTeamUser(context.Background(), orgId, teamId, userId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RemoveTeamUser``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**teamId** | **string** | Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user. | +**userId** | **string** | Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRemoveTeamUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RenameTeam + +> TeamResponse RenameTeam(ctx, orgId, teamId).Team(team).Execute() + +Rename One Team + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + orgId := "4888442a3354817a7320eb61" // string | + teamId := "teamId_example" // string | + team := *openapiclient.NewTeam("32b6e34b3d91647abb20e7b8", "Name_example") // Team | + + resp, r, err := sdk.TeamsApi.RenameTeam(context.Background(), orgId, teamId).Team(team).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.RenameTeam``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `RenameTeam`: TeamResponse + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.RenameTeam`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orgId** | **string** | Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access. | +**teamId** | **string** | Unique 24-hexadecimal digit string that identifies the team that you want to rename. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRenameTeamRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **team** | [**Team**](Team.md) | Details to update on the specified team. | + +### Return type + +[**TeamResponse**](TeamResponse.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateTeamRoles + +> PaginatedTeamRole UpdateTeamRoles(ctx, groupId, teamId).TeamRole(teamRole).Execute() + +Update Team Roles in One Project + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + teamId := "teamId_example" // string | + teamRole := *openapiclient.NewTeamRole() // TeamRole | + + resp, r, err := sdk.TeamsApi.UpdateTeamRoles(context.Background(), groupId, teamId).TeamRole(teamRole).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.UpdateTeamRoles``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateTeamRoles`: PaginatedTeamRole + fmt.Fprintf(os.Stdout, "Response from `TeamsApi.UpdateTeamRoles`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**teamId** | **string** | Unique 24-hexadecimal digit string that identifies the team for which you want to update roles. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTeamRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **teamRole** | [**TeamRole**](TeamRole.md) | The project roles assigned to the specified team. | + +### Return type + +[**PaginatedTeamRole**](PaginatedTeamRole.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/TenantHardwareSpec.md b/docs/docs/TenantHardwareSpec.md new file mode 100644 index 00000000..dd6dc4c8 --- /dev/null +++ b/docs/docs/TenantHardwareSpec.md @@ -0,0 +1,56 @@ +# TenantHardwareSpec + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InstanceSize** | Pointer to **string** | Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. | [optional] + +## Methods + +### NewTenantHardwareSpec + +`func NewTenantHardwareSpec() *TenantHardwareSpec` + +NewTenantHardwareSpec instantiates a new TenantHardwareSpec object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTenantHardwareSpecWithDefaults + +`func NewTenantHardwareSpecWithDefaults() *TenantHardwareSpec` + +NewTenantHardwareSpecWithDefaults instantiates a new TenantHardwareSpec object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInstanceSize + +`func (o *TenantHardwareSpec) GetInstanceSize() string` + +GetInstanceSize returns the InstanceSize field if non-nil, zero value otherwise. + +### GetInstanceSizeOk + +`func (o *TenantHardwareSpec) GetInstanceSizeOk() (*string, bool)` + +GetInstanceSizeOk returns a tuple with the InstanceSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceSize + +`func (o *TenantHardwareSpec) SetInstanceSize(v string)` + +SetInstanceSize sets InstanceSize field to given value. + +### HasInstanceSize + +`func (o *TenantHardwareSpec) HasInstanceSize() bool` + +HasInstanceSize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TenantRegionConfig.md b/docs/docs/TenantRegionConfig.md new file mode 100644 index 00000000..e4cb3a65 --- /dev/null +++ b/docs/docs/TenantRegionConfig.md @@ -0,0 +1,160 @@ +# TenantRegionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BackingProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M2` or `M5`. | [optional] +**ElectableSpecs** | Pointer to [**HardwareSpec**](HardwareSpec.md) | | [optional] +**Priority** | Pointer to **int** | Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`. **Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively. | [optional] +**ProviderName** | Pointer to **string** | Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`. | [optional] +**RegionName** | Pointer to **string** | Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC. | [optional] + +## Methods + +### NewTenantRegionConfig + +`func NewTenantRegionConfig() *TenantRegionConfig` + +NewTenantRegionConfig instantiates a new TenantRegionConfig object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTenantRegionConfigWithDefaults + +`func NewTenantRegionConfigWithDefaults() *TenantRegionConfig` + +NewTenantRegionConfigWithDefaults instantiates a new TenantRegionConfig object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBackingProviderName + +`func (o *TenantRegionConfig) GetBackingProviderName() string` + +GetBackingProviderName returns the BackingProviderName field if non-nil, zero value otherwise. + +### GetBackingProviderNameOk + +`func (o *TenantRegionConfig) GetBackingProviderNameOk() (*string, bool)` + +GetBackingProviderNameOk returns a tuple with the BackingProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackingProviderName + +`func (o *TenantRegionConfig) SetBackingProviderName(v string)` + +SetBackingProviderName sets BackingProviderName field to given value. + +### HasBackingProviderName + +`func (o *TenantRegionConfig) HasBackingProviderName() bool` + +HasBackingProviderName returns a boolean if a field has been set. + +### GetElectableSpecs + +`func (o *TenantRegionConfig) GetElectableSpecs() HardwareSpec` + +GetElectableSpecs returns the ElectableSpecs field if non-nil, zero value otherwise. + +### GetElectableSpecsOk + +`func (o *TenantRegionConfig) GetElectableSpecsOk() (*HardwareSpec, bool)` + +GetElectableSpecsOk returns a tuple with the ElectableSpecs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElectableSpecs + +`func (o *TenantRegionConfig) SetElectableSpecs(v HardwareSpec)` + +SetElectableSpecs sets ElectableSpecs field to given value. + +### HasElectableSpecs + +`func (o *TenantRegionConfig) HasElectableSpecs() bool` + +HasElectableSpecs returns a boolean if a field has been set. + +### GetPriority + +`func (o *TenantRegionConfig) GetPriority() int` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *TenantRegionConfig) GetPriorityOk() (*int, bool)` + +GetPriorityOk returns a tuple with the Priority field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPriority + +`func (o *TenantRegionConfig) SetPriority(v int)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *TenantRegionConfig) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetProviderName + +`func (o *TenantRegionConfig) GetProviderName() string` + +GetProviderName returns the ProviderName field if non-nil, zero value otherwise. + +### GetProviderNameOk + +`func (o *TenantRegionConfig) GetProviderNameOk() (*string, bool)` + +GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProviderName + +`func (o *TenantRegionConfig) SetProviderName(v string)` + +SetProviderName sets ProviderName field to given value. + +### HasProviderName + +`func (o *TenantRegionConfig) HasProviderName() bool` + +HasProviderName returns a boolean if a field has been set. + +### GetRegionName + +`func (o *TenantRegionConfig) GetRegionName() string` + +GetRegionName returns the RegionName field if non-nil, zero value otherwise. + +### GetRegionNameOk + +`func (o *TenantRegionConfig) GetRegionNameOk() (*string, bool)` + +GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionName + +`func (o *TenantRegionConfig) SetRegionName(v string)` + +SetRegionName sets RegionName field to given value. + +### HasRegionName + +`func (o *TenantRegionConfig) HasRegionName() bool` + +HasRegionName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TenantRestore.md b/docs/docs/TenantRestore.md new file mode 100644 index 00000000..01616104 --- /dev/null +++ b/docs/docs/TenantRestore.md @@ -0,0 +1,384 @@ +# TenantRestore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterName** | Pointer to **string** | Human-readable label that identifies the source cluster. | [optional] [readonly] +**DeliveryType** | Pointer to **string** | Means by which this resource returns the snapshot to the requesting MongoDB Cloud user. | [optional] [readonly] +**ExpirationDate** | Pointer to **time.Time** | Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the restore job. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**ProjectId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project from which the restore job originated. | [optional] [readonly] +**RestoreFinishedDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**RestoreScheduledDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**SnapshotFinishedDate** | Pointer to **time.Time** | Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**SnapshotId** | **string** | Unique 24-hexadecimal digit string that identifies the snapshot to restore. | +**SnapshotUrl** | Pointer to **string** | Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`. | [optional] [readonly] +**Status** | Pointer to **string** | Phase of the restore workflow for this job at the time this resource made this request. | [optional] [readonly] +**TargetDeploymentItemName** | **string** | Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater. | +**TargetProjectId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot. | [optional] + +## Methods + +### NewTenantRestore + +`func NewTenantRestore(snapshotId string, targetDeploymentItemName string, ) *TenantRestore` + +NewTenantRestore instantiates a new TenantRestore object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTenantRestoreWithDefaults + +`func NewTenantRestoreWithDefaults() *TenantRestore` + +NewTenantRestoreWithDefaults instantiates a new TenantRestore object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetClusterName + +`func (o *TenantRestore) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *TenantRestore) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *TenantRestore) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *TenantRestore) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetDeliveryType + +`func (o *TenantRestore) GetDeliveryType() string` + +GetDeliveryType returns the DeliveryType field if non-nil, zero value otherwise. + +### GetDeliveryTypeOk + +`func (o *TenantRestore) GetDeliveryTypeOk() (*string, bool)` + +GetDeliveryTypeOk returns a tuple with the DeliveryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryType + +`func (o *TenantRestore) SetDeliveryType(v string)` + +SetDeliveryType sets DeliveryType field to given value. + +### HasDeliveryType + +`func (o *TenantRestore) HasDeliveryType() bool` + +HasDeliveryType returns a boolean if a field has been set. + +### GetExpirationDate + +`func (o *TenantRestore) GetExpirationDate() time.Time` + +GetExpirationDate returns the ExpirationDate field if non-nil, zero value otherwise. + +### GetExpirationDateOk + +`func (o *TenantRestore) GetExpirationDateOk() (*time.Time, bool)` + +GetExpirationDateOk returns a tuple with the ExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpirationDate + +`func (o *TenantRestore) SetExpirationDate(v time.Time)` + +SetExpirationDate sets ExpirationDate field to given value. + +### HasExpirationDate + +`func (o *TenantRestore) HasExpirationDate() bool` + +HasExpirationDate returns a boolean if a field has been set. + +### GetId + +`func (o *TenantRestore) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TenantRestore) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TenantRestore) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TenantRestore) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *TenantRestore) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TenantRestore) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TenantRestore) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TenantRestore) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetProjectId + +`func (o *TenantRestore) GetProjectId() string` + +GetProjectId returns the ProjectId field if non-nil, zero value otherwise. + +### GetProjectIdOk + +`func (o *TenantRestore) GetProjectIdOk() (*string, bool)` + +GetProjectIdOk returns a tuple with the ProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProjectId + +`func (o *TenantRestore) SetProjectId(v string)` + +SetProjectId sets ProjectId field to given value. + +### HasProjectId + +`func (o *TenantRestore) HasProjectId() bool` + +HasProjectId returns a boolean if a field has been set. + +### GetRestoreFinishedDate + +`func (o *TenantRestore) GetRestoreFinishedDate() time.Time` + +GetRestoreFinishedDate returns the RestoreFinishedDate field if non-nil, zero value otherwise. + +### GetRestoreFinishedDateOk + +`func (o *TenantRestore) GetRestoreFinishedDateOk() (*time.Time, bool)` + +GetRestoreFinishedDateOk returns a tuple with the RestoreFinishedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestoreFinishedDate + +`func (o *TenantRestore) SetRestoreFinishedDate(v time.Time)` + +SetRestoreFinishedDate sets RestoreFinishedDate field to given value. + +### HasRestoreFinishedDate + +`func (o *TenantRestore) HasRestoreFinishedDate() bool` + +HasRestoreFinishedDate returns a boolean if a field has been set. + +### GetRestoreScheduledDate + +`func (o *TenantRestore) GetRestoreScheduledDate() time.Time` + +GetRestoreScheduledDate returns the RestoreScheduledDate field if non-nil, zero value otherwise. + +### GetRestoreScheduledDateOk + +`func (o *TenantRestore) GetRestoreScheduledDateOk() (*time.Time, bool)` + +GetRestoreScheduledDateOk returns a tuple with the RestoreScheduledDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestoreScheduledDate + +`func (o *TenantRestore) SetRestoreScheduledDate(v time.Time)` + +SetRestoreScheduledDate sets RestoreScheduledDate field to given value. + +### HasRestoreScheduledDate + +`func (o *TenantRestore) HasRestoreScheduledDate() bool` + +HasRestoreScheduledDate returns a boolean if a field has been set. + +### GetSnapshotFinishedDate + +`func (o *TenantRestore) GetSnapshotFinishedDate() time.Time` + +GetSnapshotFinishedDate returns the SnapshotFinishedDate field if non-nil, zero value otherwise. + +### GetSnapshotFinishedDateOk + +`func (o *TenantRestore) GetSnapshotFinishedDateOk() (*time.Time, bool)` + +GetSnapshotFinishedDateOk returns a tuple with the SnapshotFinishedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotFinishedDate + +`func (o *TenantRestore) SetSnapshotFinishedDate(v time.Time)` + +SetSnapshotFinishedDate sets SnapshotFinishedDate field to given value. + +### HasSnapshotFinishedDate + +`func (o *TenantRestore) HasSnapshotFinishedDate() bool` + +HasSnapshotFinishedDate returns a boolean if a field has been set. + +### GetSnapshotId + +`func (o *TenantRestore) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *TenantRestore) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *TenantRestore) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + + +### GetSnapshotUrl + +`func (o *TenantRestore) GetSnapshotUrl() string` + +GetSnapshotUrl returns the SnapshotUrl field if non-nil, zero value otherwise. + +### GetSnapshotUrlOk + +`func (o *TenantRestore) GetSnapshotUrlOk() (*string, bool)` + +GetSnapshotUrlOk returns a tuple with the SnapshotUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotUrl + +`func (o *TenantRestore) SetSnapshotUrl(v string)` + +SetSnapshotUrl sets SnapshotUrl field to given value. + +### HasSnapshotUrl + +`func (o *TenantRestore) HasSnapshotUrl() bool` + +HasSnapshotUrl returns a boolean if a field has been set. + +### GetStatus + +`func (o *TenantRestore) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TenantRestore) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TenantRestore) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *TenantRestore) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTargetDeploymentItemName + +`func (o *TenantRestore) GetTargetDeploymentItemName() string` + +GetTargetDeploymentItemName returns the TargetDeploymentItemName field if non-nil, zero value otherwise. + +### GetTargetDeploymentItemNameOk + +`func (o *TenantRestore) GetTargetDeploymentItemNameOk() (*string, bool)` + +GetTargetDeploymentItemNameOk returns a tuple with the TargetDeploymentItemName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDeploymentItemName + +`func (o *TenantRestore) SetTargetDeploymentItemName(v string)` + +SetTargetDeploymentItemName sets TargetDeploymentItemName field to given value. + + +### GetTargetProjectId + +`func (o *TenantRestore) GetTargetProjectId() string` + +GetTargetProjectId returns the TargetProjectId field if non-nil, zero value otherwise. + +### GetTargetProjectIdOk + +`func (o *TenantRestore) GetTargetProjectIdOk() (*string, bool)` + +GetTargetProjectIdOk returns a tuple with the TargetProjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetProjectId + +`func (o *TenantRestore) SetTargetProjectId(v string)` + +SetTargetProjectId sets TargetProjectId field to given value. + +### HasTargetProjectId + +`func (o *TenantRestore) HasTargetProjectId() bool` + +HasTargetProjectId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TenantSnapshot.md b/docs/docs/TenantSnapshot.md new file mode 100644 index 00000000..8ea72e7f --- /dev/null +++ b/docs/docs/TenantSnapshot.md @@ -0,0 +1,238 @@ +# TenantSnapshot + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expiration** | Pointer to **time.Time** | Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**FinishTime** | Pointer to **time.Time** | Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the restore job. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MongoDBVersion** | Pointer to **string** | MongoDB host version that the snapshot runs. | [optional] [readonly] +**ScheduledTime** | Pointer to **time.Time** | Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**StartTime** | Pointer to **time.Time** | Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Status** | Pointer to **string** | Phase of the workflow for this snapshot at the time this resource made this request. | [optional] [readonly] + +## Methods + +### NewTenantSnapshot + +`func NewTenantSnapshot() *TenantSnapshot` + +NewTenantSnapshot instantiates a new TenantSnapshot object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTenantSnapshotWithDefaults + +`func NewTenantSnapshotWithDefaults() *TenantSnapshot` + +NewTenantSnapshotWithDefaults instantiates a new TenantSnapshot object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetExpiration + +`func (o *TenantSnapshot) GetExpiration() time.Time` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *TenantSnapshot) GetExpirationOk() (*time.Time, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *TenantSnapshot) SetExpiration(v time.Time)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *TenantSnapshot) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetFinishTime + +`func (o *TenantSnapshot) GetFinishTime() time.Time` + +GetFinishTime returns the FinishTime field if non-nil, zero value otherwise. + +### GetFinishTimeOk + +`func (o *TenantSnapshot) GetFinishTimeOk() (*time.Time, bool)` + +GetFinishTimeOk returns a tuple with the FinishTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinishTime + +`func (o *TenantSnapshot) SetFinishTime(v time.Time)` + +SetFinishTime sets FinishTime field to given value. + +### HasFinishTime + +`func (o *TenantSnapshot) HasFinishTime() bool` + +HasFinishTime returns a boolean if a field has been set. + +### GetId + +`func (o *TenantSnapshot) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TenantSnapshot) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TenantSnapshot) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TenantSnapshot) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinks + +`func (o *TenantSnapshot) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TenantSnapshot) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TenantSnapshot) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TenantSnapshot) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMongoDBVersion + +`func (o *TenantSnapshot) GetMongoDBVersion() string` + +GetMongoDBVersion returns the MongoDBVersion field if non-nil, zero value otherwise. + +### GetMongoDBVersionOk + +`func (o *TenantSnapshot) GetMongoDBVersionOk() (*string, bool)` + +GetMongoDBVersionOk returns a tuple with the MongoDBVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMongoDBVersion + +`func (o *TenantSnapshot) SetMongoDBVersion(v string)` + +SetMongoDBVersion sets MongoDBVersion field to given value. + +### HasMongoDBVersion + +`func (o *TenantSnapshot) HasMongoDBVersion() bool` + +HasMongoDBVersion returns a boolean if a field has been set. + +### GetScheduledTime + +`func (o *TenantSnapshot) GetScheduledTime() time.Time` + +GetScheduledTime returns the ScheduledTime field if non-nil, zero value otherwise. + +### GetScheduledTimeOk + +`func (o *TenantSnapshot) GetScheduledTimeOk() (*time.Time, bool)` + +GetScheduledTimeOk returns a tuple with the ScheduledTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduledTime + +`func (o *TenantSnapshot) SetScheduledTime(v time.Time)` + +SetScheduledTime sets ScheduledTime field to given value. + +### HasScheduledTime + +`func (o *TenantSnapshot) HasScheduledTime() bool` + +HasScheduledTime returns a boolean if a field has been set. + +### GetStartTime + +`func (o *TenantSnapshot) GetStartTime() time.Time` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *TenantSnapshot) GetStartTimeOk() (*time.Time, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *TenantSnapshot) SetStartTime(v time.Time)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *TenantSnapshot) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetStatus + +`func (o *TenantSnapshot) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TenantSnapshot) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TenantSnapshot) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *TenantSnapshot) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TestApi.md b/docs/docs/TestApi.md new file mode 100644 index 00000000..68de4f63 --- /dev/null +++ b/docs/docs/TestApi.md @@ -0,0 +1,79 @@ +# \TestApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**VersionedExample**](TestApi.md#VersionedExample) | **Get** /api/atlas/v2/example/info | Example resource info for versioning of the Atlas API + + + +## VersionedExample + +> ExampleResourceResponseView20230201 VersionedExample(ctx).AdditionalInfo(additionalInfo).Execute() + +Example resource info for versioning of the Atlas API + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + additionalInfo := true // bool | (optional) (default to false) + + resp, r, err := sdk.TestApi.VersionedExample(context.Background()).AdditionalInfo(additionalInfo).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TestApi.VersionedExample``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `VersionedExample`: ExampleResourceResponseView20230201 + fmt.Fprintf(os.Stdout, "Response from `TestApi.VersionedExample`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiVersionedExampleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **additionalInfo** | **bool** | | [default to false] + +### Return type + +[**ExampleResourceResponseView20230201**](ExampleResourceResponseView20230201.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-02-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ThirdPartyIntegrationsApi.md b/docs/docs/ThirdPartyIntegrationsApi.md new file mode 100644 index 00000000..23bbb4b9 --- /dev/null +++ b/docs/docs/ThirdPartyIntegrationsApi.md @@ -0,0 +1,415 @@ +# \ThirdPartyIntegrationsApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateThirdPartyIntegration**](ThirdPartyIntegrationsApi.md#CreateThirdPartyIntegration) | **Post** /api/atlas/v2/groups/{groupId}/integrations/{integrationType} | Configure One Third-Party Service Integration +[**DeleteThirdPartyIntegration**](ThirdPartyIntegrationsApi.md#DeleteThirdPartyIntegration) | **Delete** /api/atlas/v2/groups/{groupId}/integrations/{integrationType} | Remove One Third-Party Service Integration +[**GetThirdPartyIntegration**](ThirdPartyIntegrationsApi.md#GetThirdPartyIntegration) | **Get** /api/atlas/v2/groups/{groupId}/integrations/{integrationType} | Return One Third-Party Service Integration +[**ListThirdPartyIntegrations**](ThirdPartyIntegrationsApi.md#ListThirdPartyIntegrations) | **Get** /api/atlas/v2/groups/{groupId}/integrations | Return All Active Third-Party Service Integrations +[**UpdateThirdPartyIntegration**](ThirdPartyIntegrationsApi.md#UpdateThirdPartyIntegration) | **Put** /api/atlas/v2/groups/{groupId}/integrations/{integrationType} | Update One Third-Party Service Integration + + + +## CreateThirdPartyIntegration + +> PaginatedIntegration CreateThirdPartyIntegration(ctx, integrationType, groupId).Integration(integration).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Configure One Third-Party Service Integration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + integrationType := "integrationType_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + integration := openapiclient.Integration{Datadog: openapiclient.NewDatadog("****************************a23c")} // Integration | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ThirdPartyIntegrationsApi.CreateThirdPartyIntegration(context.Background(), integrationType, groupId).Integration(integration).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ThirdPartyIntegrationsApi.CreateThirdPartyIntegration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `CreateThirdPartyIntegration`: PaginatedIntegration + fmt.Fprintf(os.Stdout, "Response from `ThirdPartyIntegrationsApi.CreateThirdPartyIntegration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationType** | **string** | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateThirdPartyIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **integration** | [**Integration**](Integration.md) | Third-party integration that you want to configure for your project. | + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedIntegration**](PaginatedIntegration.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteThirdPartyIntegration + +> DeleteThirdPartyIntegration(ctx, integrationType, groupId).Execute() + +Remove One Third-Party Service Integration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + integrationType := "integrationType_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + + r, err := sdk.ThirdPartyIntegrationsApi.DeleteThirdPartyIntegration(context.Background(), integrationType, groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ThirdPartyIntegrationsApi.DeleteThirdPartyIntegration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationType** | **string** | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteThirdPartyIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetThirdPartyIntegration + +> Integration GetThirdPartyIntegration(ctx, groupId, integrationType).Execute() + +Return One Third-Party Service Integration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + integrationType := "integrationType_example" // string | + + resp, r, err := sdk.ThirdPartyIntegrationsApi.GetThirdPartyIntegration(context.Background(), groupId, integrationType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ThirdPartyIntegrationsApi.GetThirdPartyIntegration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `GetThirdPartyIntegration`: Integration + fmt.Fprintf(os.Stdout, "Response from `ThirdPartyIntegrationsApi.GetThirdPartyIntegration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**integrationType** | **string** | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetThirdPartyIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Integration**](Integration.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListThirdPartyIntegrations + +> PaginatedIntegration ListThirdPartyIntegrations(ctx, groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All Active Third-Party Service Integrations + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ThirdPartyIntegrationsApi.ListThirdPartyIntegrations(context.Background(), groupId).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ThirdPartyIntegrationsApi.ListThirdPartyIntegrations``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListThirdPartyIntegrations`: PaginatedIntegration + fmt.Fprintf(os.Stdout, "Response from `ThirdPartyIntegrationsApi.ListThirdPartyIntegrations`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListThirdPartyIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedIntegration**](PaginatedIntegration.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateThirdPartyIntegration + +> PaginatedIntegration UpdateThirdPartyIntegration(ctx, integrationType, groupId).Integration(integration).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Update One Third-Party Service Integration + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + integrationType := "integrationType_example" // string | + groupId := "32b6e34b3d91647abb20e7b8" // string | + integration := openapiclient.Integration{Datadog: openapiclient.NewDatadog("****************************a23c")} // Integration | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.ThirdPartyIntegrationsApi.UpdateThirdPartyIntegration(context.Background(), integrationType, groupId).Integration(integration).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ThirdPartyIntegrationsApi.UpdateThirdPartyIntegration``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `UpdateThirdPartyIntegration`: PaginatedIntegration + fmt.Fprintf(os.Stdout, "Response from `ThirdPartyIntegrationsApi.UpdateThirdPartyIntegration`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationType** | **string** | Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. | +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateThirdPartyIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **integration** | [**Integration**](Integration.md) | Third-party integration that you want to configure for your project. | + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedIntegration**](PaginatedIntegration.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/ThresholdViewInteger.md b/docs/docs/ThresholdViewInteger.md new file mode 100644 index 00000000..0a43d5a1 --- /dev/null +++ b/docs/docs/ThresholdViewInteger.md @@ -0,0 +1,108 @@ +# ThresholdViewInteger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **int** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to **string** | Element used to express the quantity. This can be an element of time, storage capacity, and the like. | [optional] + +## Methods + +### NewThresholdViewInteger + +`func NewThresholdViewInteger() *ThresholdViewInteger` + +NewThresholdViewInteger instantiates a new ThresholdViewInteger object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewThresholdViewIntegerWithDefaults + +`func NewThresholdViewIntegerWithDefaults() *ThresholdViewInteger` + +NewThresholdViewIntegerWithDefaults instantiates a new ThresholdViewInteger object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOperator + +`func (o *ThresholdViewInteger) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ThresholdViewInteger) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ThresholdViewInteger) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ThresholdViewInteger) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *ThresholdViewInteger) GetThreshold() int` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *ThresholdViewInteger) GetThresholdOk() (*int, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *ThresholdViewInteger) SetThreshold(v int)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *ThresholdViewInteger) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *ThresholdViewInteger) GetUnits() string` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *ThresholdViewInteger) GetUnitsOk() (*string, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *ThresholdViewInteger) SetUnits(v string)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *ThresholdViewInteger) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TimeMetricAlert.md b/docs/docs/TimeMetricAlert.md new file mode 100644 index 00000000..946f23d7 --- /dev/null +++ b/docs/docs/TimeMetricAlert.md @@ -0,0 +1,489 @@ +# TimeMetricAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcknowledgedUntil** | **time.Time** | Date and time until which this alert has been acknowledged. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert. - To acknowledge this alert forever, set the parameter value to 100 years in the future. - To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past. | +**AcknowledgementComment** | Pointer to **string** | Comment that a MongoDB Cloud user submitted when acknowledging the alert. | [optional] +**AcknowledgingUsername** | Pointer to **string** | MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert. | [optional] [readonly] +**AlertConfigId** | **string** | Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert. | [readonly] +**ClusterName** | Pointer to **string** | Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters. | [optional] [readonly] +**Created** | **time.Time** | Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**TimeMetricValue**](TimeMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventTypeViewAlertable**](HostMetricEventTypeViewAlertable.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project that owns this alert. | [optional] [readonly] +**HostnameAndPort** | Pointer to **string** | Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies this alert. | [readonly] +**LastNotified** | Pointer to **time.Time** | Date and time that any notifications were last sent for this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Name of the metric against which Atlas checks the configured `metricThreshold.threshold`. To learn more about the available metrics, see <a href=\"https://www.mongodb.com/docs/atlas/reference/alert-host-metrics/#std-label-measurement-types\" target=\"_blank\">Host Metrics</a>. **NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see <a href=\"https://dochub.mongodb.org/core/alert-config-serverless-measurements\" target=\"_blank\">Serverless Measurements</a>. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets. | [optional] [readonly] +**Resolved** | Pointer to **time.Time** | Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`. | [optional] [readonly] +**Status** | **string** | State of this alert at the time you requested its details. | [readonly] +**Updated** | **time.Time** | Date and time when someone last updated this alert. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] + +## Methods + +### NewTimeMetricAlert + +`func NewTimeMetricAlert(acknowledgedUntil time.Time, alertConfigId string, created time.Time, eventTypeName HostMetricEventTypeViewAlertable, id string, status string, updated time.Time, ) *TimeMetricAlert` + +NewTimeMetricAlert instantiates a new TimeMetricAlert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTimeMetricAlertWithDefaults + +`func NewTimeMetricAlertWithDefaults() *TimeMetricAlert` + +NewTimeMetricAlertWithDefaults instantiates a new TimeMetricAlert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcknowledgedUntil + +`func (o *TimeMetricAlert) GetAcknowledgedUntil() time.Time` + +GetAcknowledgedUntil returns the AcknowledgedUntil field if non-nil, zero value otherwise. + +### GetAcknowledgedUntilOk + +`func (o *TimeMetricAlert) GetAcknowledgedUntilOk() (*time.Time, bool)` + +GetAcknowledgedUntilOk returns a tuple with the AcknowledgedUntil field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgedUntil + +`func (o *TimeMetricAlert) SetAcknowledgedUntil(v time.Time)` + +SetAcknowledgedUntil sets AcknowledgedUntil field to given value. + + +### GetAcknowledgementComment + +`func (o *TimeMetricAlert) GetAcknowledgementComment() string` + +GetAcknowledgementComment returns the AcknowledgementComment field if non-nil, zero value otherwise. + +### GetAcknowledgementCommentOk + +`func (o *TimeMetricAlert) GetAcknowledgementCommentOk() (*string, bool)` + +GetAcknowledgementCommentOk returns a tuple with the AcknowledgementComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgementComment + +`func (o *TimeMetricAlert) SetAcknowledgementComment(v string)` + +SetAcknowledgementComment sets AcknowledgementComment field to given value. + +### HasAcknowledgementComment + +`func (o *TimeMetricAlert) HasAcknowledgementComment() bool` + +HasAcknowledgementComment returns a boolean if a field has been set. + +### GetAcknowledgingUsername + +`func (o *TimeMetricAlert) GetAcknowledgingUsername() string` + +GetAcknowledgingUsername returns the AcknowledgingUsername field if non-nil, zero value otherwise. + +### GetAcknowledgingUsernameOk + +`func (o *TimeMetricAlert) GetAcknowledgingUsernameOk() (*string, bool)` + +GetAcknowledgingUsernameOk returns a tuple with the AcknowledgingUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcknowledgingUsername + +`func (o *TimeMetricAlert) SetAcknowledgingUsername(v string)` + +SetAcknowledgingUsername sets AcknowledgingUsername field to given value. + +### HasAcknowledgingUsername + +`func (o *TimeMetricAlert) HasAcknowledgingUsername() bool` + +HasAcknowledgingUsername returns a boolean if a field has been set. + +### GetAlertConfigId + +`func (o *TimeMetricAlert) GetAlertConfigId() string` + +GetAlertConfigId returns the AlertConfigId field if non-nil, zero value otherwise. + +### GetAlertConfigIdOk + +`func (o *TimeMetricAlert) GetAlertConfigIdOk() (*string, bool)` + +GetAlertConfigIdOk returns a tuple with the AlertConfigId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertConfigId + +`func (o *TimeMetricAlert) SetAlertConfigId(v string)` + +SetAlertConfigId sets AlertConfigId field to given value. + + +### GetClusterName + +`func (o *TimeMetricAlert) GetClusterName() string` + +GetClusterName returns the ClusterName field if non-nil, zero value otherwise. + +### GetClusterNameOk + +`func (o *TimeMetricAlert) GetClusterNameOk() (*string, bool)` + +GetClusterNameOk returns a tuple with the ClusterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterName + +`func (o *TimeMetricAlert) SetClusterName(v string)` + +SetClusterName sets ClusterName field to given value. + +### HasClusterName + +`func (o *TimeMetricAlert) HasClusterName() bool` + +HasClusterName returns a boolean if a field has been set. + +### GetCreated + +`func (o *TimeMetricAlert) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TimeMetricAlert) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TimeMetricAlert) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *TimeMetricAlert) GetCurrentValue() TimeMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *TimeMetricAlert) GetCurrentValueOk() (*TimeMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *TimeMetricAlert) SetCurrentValue(v TimeMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *TimeMetricAlert) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *TimeMetricAlert) GetEventTypeName() HostMetricEventTypeViewAlertable` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *TimeMetricAlert) GetEventTypeNameOk() (*HostMetricEventTypeViewAlertable, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *TimeMetricAlert) SetEventTypeName(v HostMetricEventTypeViewAlertable)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *TimeMetricAlert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *TimeMetricAlert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *TimeMetricAlert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *TimeMetricAlert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetHostnameAndPort + +`func (o *TimeMetricAlert) GetHostnameAndPort() string` + +GetHostnameAndPort returns the HostnameAndPort field if non-nil, zero value otherwise. + +### GetHostnameAndPortOk + +`func (o *TimeMetricAlert) GetHostnameAndPortOk() (*string, bool)` + +GetHostnameAndPortOk returns a tuple with the HostnameAndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostnameAndPort + +`func (o *TimeMetricAlert) SetHostnameAndPort(v string)` + +SetHostnameAndPort sets HostnameAndPort field to given value. + +### HasHostnameAndPort + +`func (o *TimeMetricAlert) HasHostnameAndPort() bool` + +HasHostnameAndPort returns a boolean if a field has been set. + +### GetId + +`func (o *TimeMetricAlert) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TimeMetricAlert) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TimeMetricAlert) SetId(v string)` + +SetId sets Id field to given value. + + +### GetLastNotified + +`func (o *TimeMetricAlert) GetLastNotified() time.Time` + +GetLastNotified returns the LastNotified field if non-nil, zero value otherwise. + +### GetLastNotifiedOk + +`func (o *TimeMetricAlert) GetLastNotifiedOk() (*time.Time, bool)` + +GetLastNotifiedOk returns a tuple with the LastNotified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastNotified + +`func (o *TimeMetricAlert) SetLastNotified(v time.Time)` + +SetLastNotified sets LastNotified field to given value. + +### HasLastNotified + +`func (o *TimeMetricAlert) HasLastNotified() bool` + +HasLastNotified returns a boolean if a field has been set. + +### GetLinks + +`func (o *TimeMetricAlert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TimeMetricAlert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TimeMetricAlert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TimeMetricAlert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *TimeMetricAlert) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *TimeMetricAlert) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *TimeMetricAlert) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *TimeMetricAlert) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *TimeMetricAlert) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *TimeMetricAlert) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *TimeMetricAlert) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *TimeMetricAlert) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *TimeMetricAlert) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *TimeMetricAlert) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *TimeMetricAlert) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *TimeMetricAlert) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetResolved + +`func (o *TimeMetricAlert) GetResolved() time.Time` + +GetResolved returns the Resolved field if non-nil, zero value otherwise. + +### GetResolvedOk + +`func (o *TimeMetricAlert) GetResolvedOk() (*time.Time, bool)` + +GetResolvedOk returns a tuple with the Resolved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResolved + +`func (o *TimeMetricAlert) SetResolved(v time.Time)` + +SetResolved sets Resolved field to given value. + +### HasResolved + +`func (o *TimeMetricAlert) HasResolved() bool` + +HasResolved returns a boolean if a field has been set. + +### GetStatus + +`func (o *TimeMetricAlert) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TimeMetricAlert) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TimeMetricAlert) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetUpdated + +`func (o *TimeMetricAlert) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *TimeMetricAlert) GetUpdatedOk() (*time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *TimeMetricAlert) SetUpdated(v time.Time)` + +SetUpdated sets Updated field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TimeMetricEvent.md b/docs/docs/TimeMetricEvent.md new file mode 100644 index 00000000..e13cd12f --- /dev/null +++ b/docs/docs/TimeMetricEvent.md @@ -0,0 +1,483 @@ +# TimeMetricEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**CurrentValue** | Pointer to [**TimeMetricValue**](TimeMetricValue.md) | | [optional] +**EventTypeName** | [**HostMetricEventType**](HostMetricEventType.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MetricName** | Pointer to **string** | Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**Port** | Pointer to **int** | IANA port on which the MongoDB process listens for requests. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**ReplicaSetName** | Pointer to **string** | Human-readable label of the replica set associated with the event. | [optional] [readonly] +**ShardName** | Pointer to **string** | Human-readable label of the shard associated with the event. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewTimeMetricEvent + +`func NewTimeMetricEvent(created time.Time, eventTypeName HostMetricEventType, id string, ) *TimeMetricEvent` + +NewTimeMetricEvent instantiates a new TimeMetricEvent object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTimeMetricEventWithDefaults + +`func NewTimeMetricEventWithDefaults() *TimeMetricEvent` + +NewTimeMetricEventWithDefaults instantiates a new TimeMetricEvent object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *TimeMetricEvent) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *TimeMetricEvent) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *TimeMetricEvent) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *TimeMetricEvent) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *TimeMetricEvent) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TimeMetricEvent) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TimeMetricEvent) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetCurrentValue + +`func (o *TimeMetricEvent) GetCurrentValue() TimeMetricValue` + +GetCurrentValue returns the CurrentValue field if non-nil, zero value otherwise. + +### GetCurrentValueOk + +`func (o *TimeMetricEvent) GetCurrentValueOk() (*TimeMetricValue, bool)` + +GetCurrentValueOk returns a tuple with the CurrentValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentValue + +`func (o *TimeMetricEvent) SetCurrentValue(v TimeMetricValue)` + +SetCurrentValue sets CurrentValue field to given value. + +### HasCurrentValue + +`func (o *TimeMetricEvent) HasCurrentValue() bool` + +HasCurrentValue returns a boolean if a field has been set. + +### GetEventTypeName + +`func (o *TimeMetricEvent) GetEventTypeName() HostMetricEventType` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *TimeMetricEvent) GetEventTypeNameOk() (*HostMetricEventType, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *TimeMetricEvent) SetEventTypeName(v HostMetricEventType)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *TimeMetricEvent) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *TimeMetricEvent) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *TimeMetricEvent) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *TimeMetricEvent) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *TimeMetricEvent) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TimeMetricEvent) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TimeMetricEvent) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *TimeMetricEvent) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *TimeMetricEvent) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *TimeMetricEvent) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *TimeMetricEvent) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *TimeMetricEvent) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *TimeMetricEvent) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *TimeMetricEvent) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *TimeMetricEvent) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMetricName + +`func (o *TimeMetricEvent) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *TimeMetricEvent) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *TimeMetricEvent) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *TimeMetricEvent) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetOrgId + +`func (o *TimeMetricEvent) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *TimeMetricEvent) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *TimeMetricEvent) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *TimeMetricEvent) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPort + +`func (o *TimeMetricEvent) GetPort() int` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *TimeMetricEvent) GetPortOk() (*int, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *TimeMetricEvent) SetPort(v int)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *TimeMetricEvent) HasPort() bool` + +HasPort returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *TimeMetricEvent) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *TimeMetricEvent) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *TimeMetricEvent) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *TimeMetricEvent) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *TimeMetricEvent) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *TimeMetricEvent) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *TimeMetricEvent) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *TimeMetricEvent) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *TimeMetricEvent) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *TimeMetricEvent) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *TimeMetricEvent) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *TimeMetricEvent) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetReplicaSetName + +`func (o *TimeMetricEvent) GetReplicaSetName() string` + +GetReplicaSetName returns the ReplicaSetName field if non-nil, zero value otherwise. + +### GetReplicaSetNameOk + +`func (o *TimeMetricEvent) GetReplicaSetNameOk() (*string, bool)` + +GetReplicaSetNameOk returns a tuple with the ReplicaSetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplicaSetName + +`func (o *TimeMetricEvent) SetReplicaSetName(v string)` + +SetReplicaSetName sets ReplicaSetName field to given value. + +### HasReplicaSetName + +`func (o *TimeMetricEvent) HasReplicaSetName() bool` + +HasReplicaSetName returns a boolean if a field has been set. + +### GetShardName + +`func (o *TimeMetricEvent) GetShardName() string` + +GetShardName returns the ShardName field if non-nil, zero value otherwise. + +### GetShardNameOk + +`func (o *TimeMetricEvent) GetShardNameOk() (*string, bool)` + +GetShardNameOk returns a tuple with the ShardName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShardName + +`func (o *TimeMetricEvent) SetShardName(v string)` + +SetShardName sets ShardName field to given value. + +### HasShardName + +`func (o *TimeMetricEvent) HasShardName() bool` + +HasShardName returns a boolean if a field has been set. + +### GetUserId + +`func (o *TimeMetricEvent) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *TimeMetricEvent) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *TimeMetricEvent) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *TimeMetricEvent) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *TimeMetricEvent) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *TimeMetricEvent) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *TimeMetricEvent) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *TimeMetricEvent) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TimeMetricThreshold.md b/docs/docs/TimeMetricThreshold.md new file mode 100644 index 00000000..cc4932ca --- /dev/null +++ b/docs/docs/TimeMetricThreshold.md @@ -0,0 +1,160 @@ +# TimeMetricThreshold + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MetricName** | Pointer to **string** | Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**. | [optional] +**Mode** | Pointer to **string** | MongoDB Cloud computes the current metric value as an average. | [optional] +**Operator** | Pointer to [**Operator**](Operator.md) | | [optional] +**Threshold** | Pointer to **float64** | Value of metric that, when exceeded, triggers an alert. | [optional] +**Units** | Pointer to [**TimeMetricUnits**](TimeMetricUnits.md) | | [optional] [default to TIMEMETRICUNITS_HOURS] + +## Methods + +### NewTimeMetricThreshold + +`func NewTimeMetricThreshold() *TimeMetricThreshold` + +NewTimeMetricThreshold instantiates a new TimeMetricThreshold object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTimeMetricThresholdWithDefaults + +`func NewTimeMetricThresholdWithDefaults() *TimeMetricThreshold` + +NewTimeMetricThresholdWithDefaults instantiates a new TimeMetricThreshold object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetricName + +`func (o *TimeMetricThreshold) GetMetricName() string` + +GetMetricName returns the MetricName field if non-nil, zero value otherwise. + +### GetMetricNameOk + +`func (o *TimeMetricThreshold) GetMetricNameOk() (*string, bool)` + +GetMetricNameOk returns a tuple with the MetricName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetricName + +`func (o *TimeMetricThreshold) SetMetricName(v string)` + +SetMetricName sets MetricName field to given value. + +### HasMetricName + +`func (o *TimeMetricThreshold) HasMetricName() bool` + +HasMetricName returns a boolean if a field has been set. + +### GetMode + +`func (o *TimeMetricThreshold) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *TimeMetricThreshold) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *TimeMetricThreshold) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *TimeMetricThreshold) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetOperator + +`func (o *TimeMetricThreshold) GetOperator() Operator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *TimeMetricThreshold) GetOperatorOk() (*Operator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *TimeMetricThreshold) SetOperator(v Operator)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *TimeMetricThreshold) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetThreshold + +`func (o *TimeMetricThreshold) GetThreshold() float64` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *TimeMetricThreshold) GetThresholdOk() (*float64, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *TimeMetricThreshold) SetThreshold(v float64)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *TimeMetricThreshold) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetUnits + +`func (o *TimeMetricThreshold) GetUnits() TimeMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *TimeMetricThreshold) GetUnitsOk() (*TimeMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *TimeMetricThreshold) SetUnits(v TimeMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *TimeMetricThreshold) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TimeMetricUnits.md b/docs/docs/TimeMetricUnits.md new file mode 100644 index 00000000..d230f3a4 --- /dev/null +++ b/docs/docs/TimeMetricUnits.md @@ -0,0 +1,23 @@ +# TimeMetricUnits + +## Enum + + +* `NANOSECONDS` (value: `"NANOSECONDS"`) + +* `MILLISECONDS` (value: `"MILLISECONDS"`) + +* `MILLION_MINUTES` (value: `"MILLION_MINUTES"`) + +* `SECONDS` (value: `"SECONDS"`) + +* `MINUTES` (value: `"MINUTES"`) + +* `HOURS` (value: `"HOURS"`) + +* `DAYS` (value: `"DAYS"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TimeMetricValue.md b/docs/docs/TimeMetricValue.md new file mode 100644 index 00000000..42ae236b --- /dev/null +++ b/docs/docs/TimeMetricValue.md @@ -0,0 +1,82 @@ +# TimeMetricValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Number** | Pointer to **float64** | Amount of the **metricName** recorded at the time of the event. This value triggered the alert. | [optional] [readonly] +**Units** | Pointer to [**TimeMetricUnits**](TimeMetricUnits.md) | | [optional] [default to TIMEMETRICUNITS_HOURS] + +## Methods + +### NewTimeMetricValue + +`func NewTimeMetricValue() *TimeMetricValue` + +NewTimeMetricValue instantiates a new TimeMetricValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTimeMetricValueWithDefaults + +`func NewTimeMetricValueWithDefaults() *TimeMetricValue` + +NewTimeMetricValueWithDefaults instantiates a new TimeMetricValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNumber + +`func (o *TimeMetricValue) GetNumber() float64` + +GetNumber returns the Number field if non-nil, zero value otherwise. + +### GetNumberOk + +`func (o *TimeMetricValue) GetNumberOk() (*float64, bool)` + +GetNumberOk returns a tuple with the Number field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumber + +`func (o *TimeMetricValue) SetNumber(v float64)` + +SetNumber sets Number field to given value. + +### HasNumber + +`func (o *TimeMetricValue) HasNumber() bool` + +HasNumber returns a boolean if a field has been set. + +### GetUnits + +`func (o *TimeMetricValue) GetUnits() TimeMetricUnits` + +GetUnits returns the Units field if non-nil, zero value otherwise. + +### GetUnitsOk + +`func (o *TimeMetricValue) GetUnitsOk() (*TimeMetricUnits, bool)` + +GetUnitsOk returns a tuple with the Units field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnits + +`func (o *TimeMetricValue) SetUnits(v TimeMetricUnits)` + +SetUnits sets Units field to given value. + +### HasUnits + +`func (o *TimeMetricValue) HasUnits() bool` + +HasUnits returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Toggle.md b/docs/docs/Toggle.md new file mode 100644 index 00000000..ff843462 --- /dev/null +++ b/docs/docs/Toggle.md @@ -0,0 +1,56 @@ +# Toggle + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Flag that indicates whether to enable or disable the specified alert configuration in the specified project. | [optional] + +## Methods + +### NewToggle + +`func NewToggle() *Toggle` + +NewToggle instantiates a new Toggle object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewToggleWithDefaults + +`func NewToggleWithDefaults() *Toggle` + +NewToggleWithDefaults instantiates a new Toggle object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEnabled + +`func (o *Toggle) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Toggle) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Toggle) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Toggle) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilterasciiFolding.md b/docs/docs/TokenFilterasciiFolding.md new file mode 100644 index 00000000..f114756b --- /dev/null +++ b/docs/docs/TokenFilterasciiFolding.md @@ -0,0 +1,77 @@ +# TokenFilterasciiFolding + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OriginalTokens** | Pointer to **string** | Value that indicates whether to include or omit the original tokens in the output of the token filter. Choose `include` if you want to support queries on both the original tokens as well as the converted forms. Choose `omit` if you want to query only on the converted forms of the original tokens. | [optional] [default to "omit"] +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilterasciiFolding + +`func NewTokenFilterasciiFolding(type_ string, ) *TokenFilterasciiFolding` + +NewTokenFilterasciiFolding instantiates a new TokenFilterasciiFolding object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilterasciiFoldingWithDefaults + +`func NewTokenFilterasciiFoldingWithDefaults() *TokenFilterasciiFolding` + +NewTokenFilterasciiFoldingWithDefaults instantiates a new TokenFilterasciiFolding object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOriginalTokens + +`func (o *TokenFilterasciiFolding) GetOriginalTokens() string` + +GetOriginalTokens returns the OriginalTokens field if non-nil, zero value otherwise. + +### GetOriginalTokensOk + +`func (o *TokenFilterasciiFolding) GetOriginalTokensOk() (*string, bool)` + +GetOriginalTokensOk returns a tuple with the OriginalTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalTokens + +`func (o *TokenFilterasciiFolding) SetOriginalTokens(v string)` + +SetOriginalTokens sets OriginalTokens field to given value. + +### HasOriginalTokens + +`func (o *TokenFilterasciiFolding) HasOriginalTokens() bool` + +HasOriginalTokens returns a boolean if a field has been set. + +### GetType + +`func (o *TokenFilterasciiFolding) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilterasciiFolding) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilterasciiFolding) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilterdaitchMokotoffSoundex.md b/docs/docs/TokenFilterdaitchMokotoffSoundex.md new file mode 100644 index 00000000..d8f53335 --- /dev/null +++ b/docs/docs/TokenFilterdaitchMokotoffSoundex.md @@ -0,0 +1,77 @@ +# TokenFilterdaitchMokotoffSoundex + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OriginalTokens** | Pointer to **string** | Value that indicates whether to include or omit the original tokens in the output of the token filter. Choose `include` if you want to support queries on both the original tokens as well as the converted forms. Choose `omit` if you want to query only on the converted forms of the original tokens. | [optional] [default to "include"] +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilterdaitchMokotoffSoundex + +`func NewTokenFilterdaitchMokotoffSoundex(type_ string, ) *TokenFilterdaitchMokotoffSoundex` + +NewTokenFilterdaitchMokotoffSoundex instantiates a new TokenFilterdaitchMokotoffSoundex object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilterdaitchMokotoffSoundexWithDefaults + +`func NewTokenFilterdaitchMokotoffSoundexWithDefaults() *TokenFilterdaitchMokotoffSoundex` + +NewTokenFilterdaitchMokotoffSoundexWithDefaults instantiates a new TokenFilterdaitchMokotoffSoundex object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOriginalTokens + +`func (o *TokenFilterdaitchMokotoffSoundex) GetOriginalTokens() string` + +GetOriginalTokens returns the OriginalTokens field if non-nil, zero value otherwise. + +### GetOriginalTokensOk + +`func (o *TokenFilterdaitchMokotoffSoundex) GetOriginalTokensOk() (*string, bool)` + +GetOriginalTokensOk returns a tuple with the OriginalTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalTokens + +`func (o *TokenFilterdaitchMokotoffSoundex) SetOriginalTokens(v string)` + +SetOriginalTokens sets OriginalTokens field to given value. + +### HasOriginalTokens + +`func (o *TokenFilterdaitchMokotoffSoundex) HasOriginalTokens() bool` + +HasOriginalTokens returns a boolean if a field has been set. + +### GetType + +`func (o *TokenFilterdaitchMokotoffSoundex) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilterdaitchMokotoffSoundex) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilterdaitchMokotoffSoundex) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilteredgeGram.md b/docs/docs/TokenFilteredgeGram.md new file mode 100644 index 00000000..ec6f524f --- /dev/null +++ b/docs/docs/TokenFilteredgeGram.md @@ -0,0 +1,119 @@ +# TokenFilteredgeGram + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxGram** | **int** | Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**. | +**MinGram** | **int** | Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**. | +**TermNotInBounds** | Pointer to **string** | Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**. | [optional] [default to "omit"] +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilteredgeGram + +`func NewTokenFilteredgeGram(maxGram int, minGram int, type_ string, ) *TokenFilteredgeGram` + +NewTokenFilteredgeGram instantiates a new TokenFilteredgeGram object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilteredgeGramWithDefaults + +`func NewTokenFilteredgeGramWithDefaults() *TokenFilteredgeGram` + +NewTokenFilteredgeGramWithDefaults instantiates a new TokenFilteredgeGram object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxGram + +`func (o *TokenFilteredgeGram) GetMaxGram() int` + +GetMaxGram returns the MaxGram field if non-nil, zero value otherwise. + +### GetMaxGramOk + +`func (o *TokenFilteredgeGram) GetMaxGramOk() (*int, bool)` + +GetMaxGramOk returns a tuple with the MaxGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxGram + +`func (o *TokenFilteredgeGram) SetMaxGram(v int)` + +SetMaxGram sets MaxGram field to given value. + + +### GetMinGram + +`func (o *TokenFilteredgeGram) GetMinGram() int` + +GetMinGram returns the MinGram field if non-nil, zero value otherwise. + +### GetMinGramOk + +`func (o *TokenFilteredgeGram) GetMinGramOk() (*int, bool)` + +GetMinGramOk returns a tuple with the MinGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinGram + +`func (o *TokenFilteredgeGram) SetMinGram(v int)` + +SetMinGram sets MinGram field to given value. + + +### GetTermNotInBounds + +`func (o *TokenFilteredgeGram) GetTermNotInBounds() string` + +GetTermNotInBounds returns the TermNotInBounds field if non-nil, zero value otherwise. + +### GetTermNotInBoundsOk + +`func (o *TokenFilteredgeGram) GetTermNotInBoundsOk() (*string, bool)` + +GetTermNotInBoundsOk returns a tuple with the TermNotInBounds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTermNotInBounds + +`func (o *TokenFilteredgeGram) SetTermNotInBounds(v string)` + +SetTermNotInBounds sets TermNotInBounds field to given value. + +### HasTermNotInBounds + +`func (o *TokenFilteredgeGram) HasTermNotInBounds() bool` + +HasTermNotInBounds returns a boolean if a field has been set. + +### GetType + +`func (o *TokenFilteredgeGram) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilteredgeGram) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilteredgeGram) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFiltericuFolding.md b/docs/docs/TokenFiltericuFolding.md new file mode 100644 index 00000000..9f9d2305 --- /dev/null +++ b/docs/docs/TokenFiltericuFolding.md @@ -0,0 +1,51 @@ +# TokenFiltericuFolding + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFiltericuFolding + +`func NewTokenFiltericuFolding(type_ string, ) *TokenFiltericuFolding` + +NewTokenFiltericuFolding instantiates a new TokenFiltericuFolding object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFiltericuFoldingWithDefaults + +`func NewTokenFiltericuFoldingWithDefaults() *TokenFiltericuFolding` + +NewTokenFiltericuFoldingWithDefaults instantiates a new TokenFiltericuFolding object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *TokenFiltericuFolding) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFiltericuFolding) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFiltericuFolding) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFiltericuNormalizer.md b/docs/docs/TokenFiltericuNormalizer.md new file mode 100644 index 00000000..2d3e7906 --- /dev/null +++ b/docs/docs/TokenFiltericuNormalizer.md @@ -0,0 +1,77 @@ +# TokenFiltericuNormalizer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NormalizationForm** | Pointer to **string** | Normalization form to apply. | [optional] [default to "nfc"] +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFiltericuNormalizer + +`func NewTokenFiltericuNormalizer(type_ string, ) *TokenFiltericuNormalizer` + +NewTokenFiltericuNormalizer instantiates a new TokenFiltericuNormalizer object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFiltericuNormalizerWithDefaults + +`func NewTokenFiltericuNormalizerWithDefaults() *TokenFiltericuNormalizer` + +NewTokenFiltericuNormalizerWithDefaults instantiates a new TokenFiltericuNormalizer object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNormalizationForm + +`func (o *TokenFiltericuNormalizer) GetNormalizationForm() string` + +GetNormalizationForm returns the NormalizationForm field if non-nil, zero value otherwise. + +### GetNormalizationFormOk + +`func (o *TokenFiltericuNormalizer) GetNormalizationFormOk() (*string, bool)` + +GetNormalizationFormOk returns a tuple with the NormalizationForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNormalizationForm + +`func (o *TokenFiltericuNormalizer) SetNormalizationForm(v string)` + +SetNormalizationForm sets NormalizationForm field to given value. + +### HasNormalizationForm + +`func (o *TokenFiltericuNormalizer) HasNormalizationForm() bool` + +HasNormalizationForm returns a boolean if a field has been set. + +### GetType + +`func (o *TokenFiltericuNormalizer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFiltericuNormalizer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFiltericuNormalizer) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilterlength.md b/docs/docs/TokenFilterlength.md new file mode 100644 index 00000000..8eaea57b --- /dev/null +++ b/docs/docs/TokenFilterlength.md @@ -0,0 +1,103 @@ +# TokenFilterlength + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Max** | Pointer to **int** | Number that specifies the maximum length of a token. Value must be greater than or equal to **min**. | [optional] [default to 255] +**Min** | Pointer to **int** | Number that specifies the minimum length of a token. This value must be less than or equal to **max**. | [optional] [default to 0] +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilterlength + +`func NewTokenFilterlength(type_ string, ) *TokenFilterlength` + +NewTokenFilterlength instantiates a new TokenFilterlength object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilterlengthWithDefaults + +`func NewTokenFilterlengthWithDefaults() *TokenFilterlength` + +NewTokenFilterlengthWithDefaults instantiates a new TokenFilterlength object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMax + +`func (o *TokenFilterlength) GetMax() int` + +GetMax returns the Max field if non-nil, zero value otherwise. + +### GetMaxOk + +`func (o *TokenFilterlength) GetMaxOk() (*int, bool)` + +GetMaxOk returns a tuple with the Max field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMax + +`func (o *TokenFilterlength) SetMax(v int)` + +SetMax sets Max field to given value. + +### HasMax + +`func (o *TokenFilterlength) HasMax() bool` + +HasMax returns a boolean if a field has been set. + +### GetMin + +`func (o *TokenFilterlength) GetMin() int` + +GetMin returns the Min field if non-nil, zero value otherwise. + +### GetMinOk + +`func (o *TokenFilterlength) GetMinOk() (*int, bool)` + +GetMinOk returns a tuple with the Min field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMin + +`func (o *TokenFilterlength) SetMin(v int)` + +SetMin sets Min field to given value. + +### HasMin + +`func (o *TokenFilterlength) HasMin() bool` + +HasMin returns a boolean if a field has been set. + +### GetType + +`func (o *TokenFilterlength) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilterlength) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilterlength) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilterlowercase.md b/docs/docs/TokenFilterlowercase.md new file mode 100644 index 00000000..89fb9274 --- /dev/null +++ b/docs/docs/TokenFilterlowercase.md @@ -0,0 +1,51 @@ +# TokenFilterlowercase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilterlowercase + +`func NewTokenFilterlowercase(type_ string, ) *TokenFilterlowercase` + +NewTokenFilterlowercase instantiates a new TokenFilterlowercase object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilterlowercaseWithDefaults + +`func NewTokenFilterlowercaseWithDefaults() *TokenFilterlowercase` + +NewTokenFilterlowercaseWithDefaults instantiates a new TokenFilterlowercase object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *TokenFilterlowercase) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilterlowercase) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilterlowercase) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilternGram.md b/docs/docs/TokenFilternGram.md new file mode 100644 index 00000000..4caf1e62 --- /dev/null +++ b/docs/docs/TokenFilternGram.md @@ -0,0 +1,119 @@ +# TokenFilternGram + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxGram** | **int** | Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**. | +**MinGram** | **int** | Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**. | +**TermNotInBounds** | Pointer to **string** | Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**. | [optional] [default to "omit"] +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilternGram + +`func NewTokenFilternGram(maxGram int, minGram int, type_ string, ) *TokenFilternGram` + +NewTokenFilternGram instantiates a new TokenFilternGram object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilternGramWithDefaults + +`func NewTokenFilternGramWithDefaults() *TokenFilternGram` + +NewTokenFilternGramWithDefaults instantiates a new TokenFilternGram object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxGram + +`func (o *TokenFilternGram) GetMaxGram() int` + +GetMaxGram returns the MaxGram field if non-nil, zero value otherwise. + +### GetMaxGramOk + +`func (o *TokenFilternGram) GetMaxGramOk() (*int, bool)` + +GetMaxGramOk returns a tuple with the MaxGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxGram + +`func (o *TokenFilternGram) SetMaxGram(v int)` + +SetMaxGram sets MaxGram field to given value. + + +### GetMinGram + +`func (o *TokenFilternGram) GetMinGram() int` + +GetMinGram returns the MinGram field if non-nil, zero value otherwise. + +### GetMinGramOk + +`func (o *TokenFilternGram) GetMinGramOk() (*int, bool)` + +GetMinGramOk returns a tuple with the MinGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinGram + +`func (o *TokenFilternGram) SetMinGram(v int)` + +SetMinGram sets MinGram field to given value. + + +### GetTermNotInBounds + +`func (o *TokenFilternGram) GetTermNotInBounds() string` + +GetTermNotInBounds returns the TermNotInBounds field if non-nil, zero value otherwise. + +### GetTermNotInBoundsOk + +`func (o *TokenFilternGram) GetTermNotInBoundsOk() (*string, bool)` + +GetTermNotInBoundsOk returns a tuple with the TermNotInBounds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTermNotInBounds + +`func (o *TokenFilternGram) SetTermNotInBounds(v string)` + +SetTermNotInBounds sets TermNotInBounds field to given value. + +### HasTermNotInBounds + +`func (o *TokenFilternGram) HasTermNotInBounds() bool` + +HasTermNotInBounds returns a boolean if a field has been set. + +### GetType + +`func (o *TokenFilternGram) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilternGram) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilternGram) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilterregex.md b/docs/docs/TokenFilterregex.md new file mode 100644 index 00000000..447a5c91 --- /dev/null +++ b/docs/docs/TokenFilterregex.md @@ -0,0 +1,114 @@ +# TokenFilterregex + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Matches** | **string** | Value that indicates whether to replace only the first matching pattern or all matching patterns. | +**Pattern** | **string** | Regular expression pattern to apply to each token. | +**Replacement** | **string** | Replacement string to substitute wherever a matching pattern occurs. | +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilterregex + +`func NewTokenFilterregex(matches string, pattern string, replacement string, type_ string, ) *TokenFilterregex` + +NewTokenFilterregex instantiates a new TokenFilterregex object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilterregexWithDefaults + +`func NewTokenFilterregexWithDefaults() *TokenFilterregex` + +NewTokenFilterregexWithDefaults instantiates a new TokenFilterregex object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMatches + +`func (o *TokenFilterregex) GetMatches() string` + +GetMatches returns the Matches field if non-nil, zero value otherwise. + +### GetMatchesOk + +`func (o *TokenFilterregex) GetMatchesOk() (*string, bool)` + +GetMatchesOk returns a tuple with the Matches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatches + +`func (o *TokenFilterregex) SetMatches(v string)` + +SetMatches sets Matches field to given value. + + +### GetPattern + +`func (o *TokenFilterregex) GetPattern() string` + +GetPattern returns the Pattern field if non-nil, zero value otherwise. + +### GetPatternOk + +`func (o *TokenFilterregex) GetPatternOk() (*string, bool)` + +GetPatternOk returns a tuple with the Pattern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPattern + +`func (o *TokenFilterregex) SetPattern(v string)` + +SetPattern sets Pattern field to given value. + + +### GetReplacement + +`func (o *TokenFilterregex) GetReplacement() string` + +GetReplacement returns the Replacement field if non-nil, zero value otherwise. + +### GetReplacementOk + +`func (o *TokenFilterregex) GetReplacementOk() (*string, bool)` + +GetReplacementOk returns a tuple with the Replacement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplacement + +`func (o *TokenFilterregex) SetReplacement(v string)` + +SetReplacement sets Replacement field to given value. + + +### GetType + +`func (o *TokenFilterregex) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilterregex) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilterregex) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilterreverse.md b/docs/docs/TokenFilterreverse.md new file mode 100644 index 00000000..64d23fe8 --- /dev/null +++ b/docs/docs/TokenFilterreverse.md @@ -0,0 +1,51 @@ +# TokenFilterreverse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilterreverse + +`func NewTokenFilterreverse(type_ string, ) *TokenFilterreverse` + +NewTokenFilterreverse instantiates a new TokenFilterreverse object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilterreverseWithDefaults + +`func NewTokenFilterreverseWithDefaults() *TokenFilterreverse` + +NewTokenFilterreverseWithDefaults instantiates a new TokenFilterreverse object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *TokenFilterreverse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilterreverse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilterreverse) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFiltershingle.md b/docs/docs/TokenFiltershingle.md new file mode 100644 index 00000000..07c61f5e --- /dev/null +++ b/docs/docs/TokenFiltershingle.md @@ -0,0 +1,93 @@ +# TokenFiltershingle + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxShingleSize** | **int** | Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**. | +**MinShingleSize** | **int** | Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**. | +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFiltershingle + +`func NewTokenFiltershingle(maxShingleSize int, minShingleSize int, type_ string, ) *TokenFiltershingle` + +NewTokenFiltershingle instantiates a new TokenFiltershingle object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFiltershingleWithDefaults + +`func NewTokenFiltershingleWithDefaults() *TokenFiltershingle` + +NewTokenFiltershingleWithDefaults instantiates a new TokenFiltershingle object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxShingleSize + +`func (o *TokenFiltershingle) GetMaxShingleSize() int` + +GetMaxShingleSize returns the MaxShingleSize field if non-nil, zero value otherwise. + +### GetMaxShingleSizeOk + +`func (o *TokenFiltershingle) GetMaxShingleSizeOk() (*int, bool)` + +GetMaxShingleSizeOk returns a tuple with the MaxShingleSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxShingleSize + +`func (o *TokenFiltershingle) SetMaxShingleSize(v int)` + +SetMaxShingleSize sets MaxShingleSize field to given value. + + +### GetMinShingleSize + +`func (o *TokenFiltershingle) GetMinShingleSize() int` + +GetMinShingleSize returns the MinShingleSize field if non-nil, zero value otherwise. + +### GetMinShingleSizeOk + +`func (o *TokenFiltershingle) GetMinShingleSizeOk() (*int, bool)` + +GetMinShingleSizeOk returns a tuple with the MinShingleSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinShingleSize + +`func (o *TokenFiltershingle) SetMinShingleSize(v int)` + +SetMinShingleSize sets MinShingleSize field to given value. + + +### GetType + +`func (o *TokenFiltershingle) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFiltershingle) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFiltershingle) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFiltersnowballStemming.md b/docs/docs/TokenFiltersnowballStemming.md new file mode 100644 index 00000000..b1af2d22 --- /dev/null +++ b/docs/docs/TokenFiltersnowballStemming.md @@ -0,0 +1,72 @@ +# TokenFiltersnowballStemming + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StemmerName** | **string** | Snowball-generated stemmer to use. | +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFiltersnowballStemming + +`func NewTokenFiltersnowballStemming(stemmerName string, type_ string, ) *TokenFiltersnowballStemming` + +NewTokenFiltersnowballStemming instantiates a new TokenFiltersnowballStemming object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFiltersnowballStemmingWithDefaults + +`func NewTokenFiltersnowballStemmingWithDefaults() *TokenFiltersnowballStemming` + +NewTokenFiltersnowballStemmingWithDefaults instantiates a new TokenFiltersnowballStemming object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStemmerName + +`func (o *TokenFiltersnowballStemming) GetStemmerName() string` + +GetStemmerName returns the StemmerName field if non-nil, zero value otherwise. + +### GetStemmerNameOk + +`func (o *TokenFiltersnowballStemming) GetStemmerNameOk() (*string, bool)` + +GetStemmerNameOk returns a tuple with the StemmerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStemmerName + +`func (o *TokenFiltersnowballStemming) SetStemmerName(v string)` + +SetStemmerName sets StemmerName field to given value. + + +### GetType + +`func (o *TokenFiltersnowballStemming) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFiltersnowballStemming) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFiltersnowballStemming) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFilterstopword.md b/docs/docs/TokenFilterstopword.md new file mode 100644 index 00000000..0c9f34bf --- /dev/null +++ b/docs/docs/TokenFilterstopword.md @@ -0,0 +1,98 @@ +# TokenFilterstopword + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IgnoreCase** | Pointer to **bool** | Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove. | [optional] [default to true] +**Tokens** | **[]string** | The stop words that correspond to the tokens to remove. Value must be one or more stop words. | +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFilterstopword + +`func NewTokenFilterstopword(tokens []string, type_ string, ) *TokenFilterstopword` + +NewTokenFilterstopword instantiates a new TokenFilterstopword object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFilterstopwordWithDefaults + +`func NewTokenFilterstopwordWithDefaults() *TokenFilterstopword` + +NewTokenFilterstopwordWithDefaults instantiates a new TokenFilterstopword object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIgnoreCase + +`func (o *TokenFilterstopword) GetIgnoreCase() bool` + +GetIgnoreCase returns the IgnoreCase field if non-nil, zero value otherwise. + +### GetIgnoreCaseOk + +`func (o *TokenFilterstopword) GetIgnoreCaseOk() (*bool, bool)` + +GetIgnoreCaseOk returns a tuple with the IgnoreCase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreCase + +`func (o *TokenFilterstopword) SetIgnoreCase(v bool)` + +SetIgnoreCase sets IgnoreCase field to given value. + +### HasIgnoreCase + +`func (o *TokenFilterstopword) HasIgnoreCase() bool` + +HasIgnoreCase returns a boolean if a field has been set. + +### GetTokens + +`func (o *TokenFilterstopword) GetTokens() []string` + +GetTokens returns the Tokens field if non-nil, zero value otherwise. + +### GetTokensOk + +`func (o *TokenFilterstopword) GetTokensOk() (*[]string, bool)` + +GetTokensOk returns a tuple with the Tokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTokens + +`func (o *TokenFilterstopword) SetTokens(v []string)` + +SetTokens sets Tokens field to given value. + + +### GetType + +`func (o *TokenFilterstopword) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFilterstopword) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFilterstopword) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenFiltertrim.md b/docs/docs/TokenFiltertrim.md new file mode 100644 index 00000000..8eb99708 --- /dev/null +++ b/docs/docs/TokenFiltertrim.md @@ -0,0 +1,51 @@ +# TokenFiltertrim + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Human-readable label that identifies this token filter type. | + +## Methods + +### NewTokenFiltertrim + +`func NewTokenFiltertrim(type_ string, ) *TokenFiltertrim` + +NewTokenFiltertrim instantiates a new TokenFiltertrim object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenFiltertrimWithDefaults + +`func NewTokenFiltertrimWithDefaults() *TokenFiltertrim` + +NewTokenFiltertrimWithDefaults instantiates a new TokenFiltertrim object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *TokenFiltertrim) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenFiltertrim) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenFiltertrim) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenizeredgeGram.md b/docs/docs/TokenizeredgeGram.md new file mode 100644 index 00000000..35dfaa8c --- /dev/null +++ b/docs/docs/TokenizeredgeGram.md @@ -0,0 +1,93 @@ +# TokenizeredgeGram + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxGram** | **int** | Characters to include in the longest token that Atlas Search creates. | +**MinGram** | **int** | Characters to include in the shortest token that Atlas Search creates. | +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizeredgeGram + +`func NewTokenizeredgeGram(maxGram int, minGram int, type_ string, ) *TokenizeredgeGram` + +NewTokenizeredgeGram instantiates a new TokenizeredgeGram object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizeredgeGramWithDefaults + +`func NewTokenizeredgeGramWithDefaults() *TokenizeredgeGram` + +NewTokenizeredgeGramWithDefaults instantiates a new TokenizeredgeGram object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxGram + +`func (o *TokenizeredgeGram) GetMaxGram() int` + +GetMaxGram returns the MaxGram field if non-nil, zero value otherwise. + +### GetMaxGramOk + +`func (o *TokenizeredgeGram) GetMaxGramOk() (*int, bool)` + +GetMaxGramOk returns a tuple with the MaxGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxGram + +`func (o *TokenizeredgeGram) SetMaxGram(v int)` + +SetMaxGram sets MaxGram field to given value. + + +### GetMinGram + +`func (o *TokenizeredgeGram) GetMinGram() int` + +GetMinGram returns the MinGram field if non-nil, zero value otherwise. + +### GetMinGramOk + +`func (o *TokenizeredgeGram) GetMinGramOk() (*int, bool)` + +GetMinGramOk returns a tuple with the MinGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinGram + +`func (o *TokenizeredgeGram) SetMinGram(v int)` + +SetMinGram sets MinGram field to given value. + + +### GetType + +`func (o *TokenizeredgeGram) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenizeredgeGram) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenizeredgeGram) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Tokenizerkeyword.md b/docs/docs/Tokenizerkeyword.md new file mode 100644 index 00000000..dbedb150 --- /dev/null +++ b/docs/docs/Tokenizerkeyword.md @@ -0,0 +1,51 @@ +# Tokenizerkeyword + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizerkeyword + +`func NewTokenizerkeyword(type_ string, ) *Tokenizerkeyword` + +NewTokenizerkeyword instantiates a new Tokenizerkeyword object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizerkeywordWithDefaults + +`func NewTokenizerkeywordWithDefaults() *Tokenizerkeyword` + +NewTokenizerkeywordWithDefaults instantiates a new Tokenizerkeyword object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *Tokenizerkeyword) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Tokenizerkeyword) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Tokenizerkeyword) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenizernGram.md b/docs/docs/TokenizernGram.md new file mode 100644 index 00000000..d3732239 --- /dev/null +++ b/docs/docs/TokenizernGram.md @@ -0,0 +1,93 @@ +# TokenizernGram + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxGram** | **int** | Characters to include in the longest token that Atlas Search creates. | +**MinGram** | **int** | Characters to include in the shortest token that Atlas Search creates. | +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizernGram + +`func NewTokenizernGram(maxGram int, minGram int, type_ string, ) *TokenizernGram` + +NewTokenizernGram instantiates a new TokenizernGram object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizernGramWithDefaults + +`func NewTokenizernGramWithDefaults() *TokenizernGram` + +NewTokenizernGramWithDefaults instantiates a new TokenizernGram object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxGram + +`func (o *TokenizernGram) GetMaxGram() int` + +GetMaxGram returns the MaxGram field if non-nil, zero value otherwise. + +### GetMaxGramOk + +`func (o *TokenizernGram) GetMaxGramOk() (*int, bool)` + +GetMaxGramOk returns a tuple with the MaxGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxGram + +`func (o *TokenizernGram) SetMaxGram(v int)` + +SetMaxGram sets MaxGram field to given value. + + +### GetMinGram + +`func (o *TokenizernGram) GetMinGram() int` + +GetMinGram returns the MinGram field if non-nil, zero value otherwise. + +### GetMinGramOk + +`func (o *TokenizernGram) GetMinGramOk() (*int, bool)` + +GetMinGramOk returns a tuple with the MinGram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinGram + +`func (o *TokenizernGram) SetMinGram(v int)` + +SetMinGram sets MinGram field to given value. + + +### GetType + +`func (o *TokenizernGram) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenizernGram) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenizernGram) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenizerregexCaptureGroup.md b/docs/docs/TokenizerregexCaptureGroup.md new file mode 100644 index 00000000..852434b0 --- /dev/null +++ b/docs/docs/TokenizerregexCaptureGroup.md @@ -0,0 +1,93 @@ +# TokenizerregexCaptureGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Group** | **int** | Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups. | +**Pattern** | **string** | Regular expression to match against. | +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizerregexCaptureGroup + +`func NewTokenizerregexCaptureGroup(group int, pattern string, type_ string, ) *TokenizerregexCaptureGroup` + +NewTokenizerregexCaptureGroup instantiates a new TokenizerregexCaptureGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizerregexCaptureGroupWithDefaults + +`func NewTokenizerregexCaptureGroupWithDefaults() *TokenizerregexCaptureGroup` + +NewTokenizerregexCaptureGroupWithDefaults instantiates a new TokenizerregexCaptureGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetGroup + +`func (o *TokenizerregexCaptureGroup) GetGroup() int` + +GetGroup returns the Group field if non-nil, zero value otherwise. + +### GetGroupOk + +`func (o *TokenizerregexCaptureGroup) GetGroupOk() (*int, bool)` + +GetGroupOk returns a tuple with the Group field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroup + +`func (o *TokenizerregexCaptureGroup) SetGroup(v int)` + +SetGroup sets Group field to given value. + + +### GetPattern + +`func (o *TokenizerregexCaptureGroup) GetPattern() string` + +GetPattern returns the Pattern field if non-nil, zero value otherwise. + +### GetPatternOk + +`func (o *TokenizerregexCaptureGroup) GetPatternOk() (*string, bool)` + +GetPatternOk returns a tuple with the Pattern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPattern + +`func (o *TokenizerregexCaptureGroup) SetPattern(v string)` + +SetPattern sets Pattern field to given value. + + +### GetType + +`func (o *TokenizerregexCaptureGroup) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenizerregexCaptureGroup) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenizerregexCaptureGroup) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenizerregexSplit.md b/docs/docs/TokenizerregexSplit.md new file mode 100644 index 00000000..13f68028 --- /dev/null +++ b/docs/docs/TokenizerregexSplit.md @@ -0,0 +1,72 @@ +# TokenizerregexSplit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pattern** | **string** | Regular expression to match against. | +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizerregexSplit + +`func NewTokenizerregexSplit(pattern string, type_ string, ) *TokenizerregexSplit` + +NewTokenizerregexSplit instantiates a new TokenizerregexSplit object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizerregexSplitWithDefaults + +`func NewTokenizerregexSplitWithDefaults() *TokenizerregexSplit` + +NewTokenizerregexSplitWithDefaults instantiates a new TokenizerregexSplit object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPattern + +`func (o *TokenizerregexSplit) GetPattern() string` + +GetPattern returns the Pattern field if non-nil, zero value otherwise. + +### GetPatternOk + +`func (o *TokenizerregexSplit) GetPatternOk() (*string, bool)` + +GetPatternOk returns a tuple with the Pattern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPattern + +`func (o *TokenizerregexSplit) SetPattern(v string)` + +SetPattern sets Pattern field to given value. + + +### GetType + +`func (o *TokenizerregexSplit) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenizerregexSplit) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenizerregexSplit) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Tokenizerstandard.md b/docs/docs/Tokenizerstandard.md new file mode 100644 index 00000000..75bbdcc3 --- /dev/null +++ b/docs/docs/Tokenizerstandard.md @@ -0,0 +1,77 @@ +# Tokenizerstandard + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxTokenLength** | Pointer to **int** | Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. | [optional] [default to 255] +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizerstandard + +`func NewTokenizerstandard(type_ string, ) *Tokenizerstandard` + +NewTokenizerstandard instantiates a new Tokenizerstandard object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizerstandardWithDefaults + +`func NewTokenizerstandardWithDefaults() *Tokenizerstandard` + +NewTokenizerstandardWithDefaults instantiates a new Tokenizerstandard object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxTokenLength + +`func (o *Tokenizerstandard) GetMaxTokenLength() int` + +GetMaxTokenLength returns the MaxTokenLength field if non-nil, zero value otherwise. + +### GetMaxTokenLengthOk + +`func (o *Tokenizerstandard) GetMaxTokenLengthOk() (*int, bool)` + +GetMaxTokenLengthOk returns a tuple with the MaxTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxTokenLength + +`func (o *Tokenizerstandard) SetMaxTokenLength(v int)` + +SetMaxTokenLength sets MaxTokenLength field to given value. + +### HasMaxTokenLength + +`func (o *Tokenizerstandard) HasMaxTokenLength() bool` + +HasMaxTokenLength returns a boolean if a field has been set. + +### GetType + +`func (o *Tokenizerstandard) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Tokenizerstandard) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Tokenizerstandard) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TokenizeruaxUrlEmail.md b/docs/docs/TokenizeruaxUrlEmail.md new file mode 100644 index 00000000..423c1d09 --- /dev/null +++ b/docs/docs/TokenizeruaxUrlEmail.md @@ -0,0 +1,77 @@ +# TokenizeruaxUrlEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxTokenLength** | Pointer to **int** | Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. | [optional] [default to 255] +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizeruaxUrlEmail + +`func NewTokenizeruaxUrlEmail(type_ string, ) *TokenizeruaxUrlEmail` + +NewTokenizeruaxUrlEmail instantiates a new TokenizeruaxUrlEmail object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizeruaxUrlEmailWithDefaults + +`func NewTokenizeruaxUrlEmailWithDefaults() *TokenizeruaxUrlEmail` + +NewTokenizeruaxUrlEmailWithDefaults instantiates a new TokenizeruaxUrlEmail object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxTokenLength + +`func (o *TokenizeruaxUrlEmail) GetMaxTokenLength() int` + +GetMaxTokenLength returns the MaxTokenLength field if non-nil, zero value otherwise. + +### GetMaxTokenLengthOk + +`func (o *TokenizeruaxUrlEmail) GetMaxTokenLengthOk() (*int, bool)` + +GetMaxTokenLengthOk returns a tuple with the MaxTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxTokenLength + +`func (o *TokenizeruaxUrlEmail) SetMaxTokenLength(v int)` + +SetMaxTokenLength sets MaxTokenLength field to given value. + +### HasMaxTokenLength + +`func (o *TokenizeruaxUrlEmail) HasMaxTokenLength() bool` + +HasMaxTokenLength returns a boolean if a field has been set. + +### GetType + +`func (o *TokenizeruaxUrlEmail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TokenizeruaxUrlEmail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TokenizeruaxUrlEmail) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Tokenizerwhitespace.md b/docs/docs/Tokenizerwhitespace.md new file mode 100644 index 00000000..a1a54261 --- /dev/null +++ b/docs/docs/Tokenizerwhitespace.md @@ -0,0 +1,77 @@ +# Tokenizerwhitespace + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxTokenLength** | Pointer to **int** | Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. | [optional] [default to 255] +**Type** | **string** | Human-readable label that identifies this tokenizer type. | + +## Methods + +### NewTokenizerwhitespace + +`func NewTokenizerwhitespace(type_ string, ) *Tokenizerwhitespace` + +NewTokenizerwhitespace instantiates a new Tokenizerwhitespace object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTokenizerwhitespaceWithDefaults + +`func NewTokenizerwhitespaceWithDefaults() *Tokenizerwhitespace` + +NewTokenizerwhitespaceWithDefaults instantiates a new Tokenizerwhitespace object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMaxTokenLength + +`func (o *Tokenizerwhitespace) GetMaxTokenLength() int` + +GetMaxTokenLength returns the MaxTokenLength field if non-nil, zero value otherwise. + +### GetMaxTokenLengthOk + +`func (o *Tokenizerwhitespace) GetMaxTokenLengthOk() (*int, bool)` + +GetMaxTokenLengthOk returns a tuple with the MaxTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxTokenLength + +`func (o *Tokenizerwhitespace) SetMaxTokenLength(v int)` + +SetMaxTokenLength sets MaxTokenLength field to given value. + +### HasMaxTokenLength + +`func (o *Tokenizerwhitespace) HasMaxTokenLength() bool` + +HasMaxTokenLength returns a boolean if a field has been set. + +### GetType + +`func (o *Tokenizerwhitespace) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Tokenizerwhitespace) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Tokenizerwhitespace) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/TriggerIngestionRequest.md b/docs/docs/TriggerIngestionRequest.md new file mode 100644 index 00000000..00c0023c --- /dev/null +++ b/docs/docs/TriggerIngestionRequest.md @@ -0,0 +1,51 @@ +# TriggerIngestionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SnapshotId** | **string** | Unique 24-hexadecimal character string that identifies the snapshot. | + +## Methods + +### NewTriggerIngestionRequest + +`func NewTriggerIngestionRequest(snapshotId string, ) *TriggerIngestionRequest` + +NewTriggerIngestionRequest instantiates a new TriggerIngestionRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTriggerIngestionRequestWithDefaults + +`func NewTriggerIngestionRequestWithDefaults() *TriggerIngestionRequest` + +NewTriggerIngestionRequestWithDefaults instantiates a new TriggerIngestionRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetSnapshotId + +`func (o *TriggerIngestionRequest) GetSnapshotId() string` + +GetSnapshotId returns the SnapshotId field if non-nil, zero value otherwise. + +### GetSnapshotIdOk + +`func (o *TriggerIngestionRequest) GetSnapshotIdOk() (*string, bool)` + +GetSnapshotIdOk returns a tuple with the SnapshotId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotId + +`func (o *TriggerIngestionRequest) SetSnapshotId(v string)` + +SetSnapshotId sets SnapshotId field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UpdateCustomDBRole.md b/docs/docs/UpdateCustomDBRole.md new file mode 100644 index 00000000..8aa183bd --- /dev/null +++ b/docs/docs/UpdateCustomDBRole.md @@ -0,0 +1,82 @@ +# UpdateCustomDBRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Actions** | Pointer to [**[]DBAction**](DBAction.md) | List of the individual privilege actions that the role grants. | [optional] +**InheritedRoles** | Pointer to [**[]InheritedRole**](InheritedRole.md) | List of the built-in roles that this custom role inherits. | [optional] + +## Methods + +### NewUpdateCustomDBRole + +`func NewUpdateCustomDBRole() *UpdateCustomDBRole` + +NewUpdateCustomDBRole instantiates a new UpdateCustomDBRole object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateCustomDBRoleWithDefaults + +`func NewUpdateCustomDBRoleWithDefaults() *UpdateCustomDBRole` + +NewUpdateCustomDBRoleWithDefaults instantiates a new UpdateCustomDBRole object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetActions + +`func (o *UpdateCustomDBRole) GetActions() []DBAction` + +GetActions returns the Actions field if non-nil, zero value otherwise. + +### GetActionsOk + +`func (o *UpdateCustomDBRole) GetActionsOk() (*[]DBAction, bool)` + +GetActionsOk returns a tuple with the Actions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActions + +`func (o *UpdateCustomDBRole) SetActions(v []DBAction)` + +SetActions sets Actions field to given value. + +### HasActions + +`func (o *UpdateCustomDBRole) HasActions() bool` + +HasActions returns a boolean if a field has been set. + +### GetInheritedRoles + +`func (o *UpdateCustomDBRole) GetInheritedRoles() []InheritedRole` + +GetInheritedRoles returns the InheritedRoles field if non-nil, zero value otherwise. + +### GetInheritedRolesOk + +`func (o *UpdateCustomDBRole) GetInheritedRolesOk() (*[]InheritedRole, bool)` + +GetInheritedRolesOk returns a tuple with the InheritedRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInheritedRoles + +`func (o *UpdateCustomDBRole) SetInheritedRoles(v []InheritedRole)` + +SetInheritedRoles sets InheritedRoles field to given value. + +### HasInheritedRoles + +`func (o *UpdateCustomDBRole) HasInheritedRoles() bool` + +HasInheritedRoles returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserAccessList.md b/docs/docs/UserAccessList.md new file mode 100644 index 00000000..5b3bd71f --- /dev/null +++ b/docs/docs/UserAccessList.md @@ -0,0 +1,212 @@ +# UserAccessList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CidrBlock** | Pointer to **string** | Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request. | [optional] +**Count** | Pointer to **int** | Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter. | [optional] [readonly] +**Created** | Pointer to **time.Time** | Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**IpAddress** | Pointer to **string** | Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request. | [optional] +**LastUsed** | Pointer to **time.Time** | Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**LastUsedAddress** | Pointer to **string** | Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewUserAccessList + +`func NewUserAccessList() *UserAccessList` + +NewUserAccessList instantiates a new UserAccessList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserAccessListWithDefaults + +`func NewUserAccessListWithDefaults() *UserAccessList` + +NewUserAccessListWithDefaults instantiates a new UserAccessList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCidrBlock + +`func (o *UserAccessList) GetCidrBlock() string` + +GetCidrBlock returns the CidrBlock field if non-nil, zero value otherwise. + +### GetCidrBlockOk + +`func (o *UserAccessList) GetCidrBlockOk() (*string, bool)` + +GetCidrBlockOk returns a tuple with the CidrBlock field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidrBlock + +`func (o *UserAccessList) SetCidrBlock(v string)` + +SetCidrBlock sets CidrBlock field to given value. + +### HasCidrBlock + +`func (o *UserAccessList) HasCidrBlock() bool` + +HasCidrBlock returns a boolean if a field has been set. + +### GetCount + +`func (o *UserAccessList) GetCount() int` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *UserAccessList) GetCountOk() (*int, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *UserAccessList) SetCount(v int)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *UserAccessList) HasCount() bool` + +HasCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *UserAccessList) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *UserAccessList) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *UserAccessList) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *UserAccessList) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *UserAccessList) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *UserAccessList) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *UserAccessList) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *UserAccessList) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetLastUsed + +`func (o *UserAccessList) GetLastUsed() time.Time` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *UserAccessList) GetLastUsedOk() (*time.Time, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *UserAccessList) SetLastUsed(v time.Time)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *UserAccessList) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### GetLastUsedAddress + +`func (o *UserAccessList) GetLastUsedAddress() string` + +GetLastUsedAddress returns the LastUsedAddress field if non-nil, zero value otherwise. + +### GetLastUsedAddressOk + +`func (o *UserAccessList) GetLastUsedAddressOk() (*string, bool)` + +GetLastUsedAddressOk returns a tuple with the LastUsedAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsedAddress + +`func (o *UserAccessList) SetLastUsedAddress(v string)` + +SetLastUsedAddress sets LastUsedAddress field to given value. + +### HasLastUsedAddress + +`func (o *UserAccessList) HasLastUsedAddress() bool` + +HasLastUsedAddress returns a boolean if a field has been set. + +### GetLinks + +`func (o *UserAccessList) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *UserAccessList) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *UserAccessList) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *UserAccessList) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserCert.md b/docs/docs/UserCert.md new file mode 100644 index 00000000..d8313f56 --- /dev/null +++ b/docs/docs/UserCert.md @@ -0,0 +1,212 @@ +# UserCert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int64** | Unique 24-hexadecimal character string that identifies this certificate. | [optional] [readonly] +**CreatedAt** | Pointer to **time.Time** | Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal character string that identifies the project. | [optional] [readonly] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**MonthsUntilExpiration** | Pointer to **int** | Number of months that the certificate remains valid until it expires. | [optional] [default to 3] +**NotAfter** | Pointer to **time.Time** | Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. | [optional] [readonly] +**Subject** | Pointer to **string** | Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253). | [optional] [readonly] + +## Methods + +### NewUserCert + +`func NewUserCert() *UserCert` + +NewUserCert instantiates a new UserCert object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserCertWithDefaults + +`func NewUserCertWithDefaults() *UserCert` + +NewUserCertWithDefaults instantiates a new UserCert object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *UserCert) GetId() int64` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserCert) GetIdOk() (*int64, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserCert) SetId(v int64)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserCert) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *UserCert) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *UserCert) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *UserCert) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *UserCert) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetGroupId + +`func (o *UserCert) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *UserCert) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *UserCert) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *UserCert) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetLinks + +`func (o *UserCert) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *UserCert) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *UserCert) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *UserCert) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetMonthsUntilExpiration + +`func (o *UserCert) GetMonthsUntilExpiration() int` + +GetMonthsUntilExpiration returns the MonthsUntilExpiration field if non-nil, zero value otherwise. + +### GetMonthsUntilExpirationOk + +`func (o *UserCert) GetMonthsUntilExpirationOk() (*int, bool)` + +GetMonthsUntilExpirationOk returns a tuple with the MonthsUntilExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonthsUntilExpiration + +`func (o *UserCert) SetMonthsUntilExpiration(v int)` + +SetMonthsUntilExpiration sets MonthsUntilExpiration field to given value. + +### HasMonthsUntilExpiration + +`func (o *UserCert) HasMonthsUntilExpiration() bool` + +HasMonthsUntilExpiration returns a boolean if a field has been set. + +### GetNotAfter + +`func (o *UserCert) GetNotAfter() time.Time` + +GetNotAfter returns the NotAfter field if non-nil, zero value otherwise. + +### GetNotAfterOk + +`func (o *UserCert) GetNotAfterOk() (*time.Time, bool)` + +GetNotAfterOk returns a tuple with the NotAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotAfter + +`func (o *UserCert) SetNotAfter(v time.Time)` + +SetNotAfter sets NotAfter field to given value. + +### HasNotAfter + +`func (o *UserCert) HasNotAfter() bool` + +HasNotAfter returns a boolean if a field has been set. + +### GetSubject + +`func (o *UserCert) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *UserCert) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *UserCert) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *UserCert) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserEventTypeViewForNdsGroup.md b/docs/docs/UserEventTypeViewForNdsGroup.md new file mode 100644 index 00000000..90350e4c --- /dev/null +++ b/docs/docs/UserEventTypeViewForNdsGroup.md @@ -0,0 +1,25 @@ +# UserEventTypeViewForNdsGroup + +## Enum + + +* `JOINED_GROUP` (value: `"JOINED_GROUP"`) + +* `REMOVED_FROM_GROUP` (value: `"REMOVED_FROM_GROUP"`) + +* `INVITED_TO_GROUP` (value: `"INVITED_TO_GROUP"`) + +* `REQUESTED_TO_JOIN_GROUP` (value: `"REQUESTED_TO_JOIN_GROUP"`) + +* `GROUP_INVITATION_DELETED` (value: `"GROUP_INVITATION_DELETED"`) + +* `USER_ROLES_CHANGED_AUDIT` (value: `"USER_ROLES_CHANGED_AUDIT"`) + +* `JOIN_GROUP_REQUEST_DENIED_AUDIT` (value: `"JOIN_GROUP_REQUEST_DENIED_AUDIT"`) + +* `JOIN_GROUP_REQUEST_APPROVED_AUDIT` (value: `"JOIN_GROUP_REQUEST_APPROVED_AUDIT"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserEventTypeViewForOrg.md b/docs/docs/UserEventTypeViewForOrg.md new file mode 100644 index 00000000..725fcefd --- /dev/null +++ b/docs/docs/UserEventTypeViewForOrg.md @@ -0,0 +1,27 @@ +# UserEventTypeViewForOrg + +## Enum + + +* `JOINED_ORG` (value: `"JOINED_ORG"`) + +* `JOINED_TEAM` (value: `"JOINED_TEAM"`) + +* `INVITED_TO_ORG` (value: `"INVITED_TO_ORG"`) + +* `ORG_INVITATION_DELETED` (value: `"ORG_INVITATION_DELETED"`) + +* `REMOVED_FROM_ORG` (value: `"REMOVED_FROM_ORG"`) + +* `REMOVED_FROM_TEAM` (value: `"REMOVED_FROM_TEAM"`) + +* `USER_ROLES_CHANGED_AUDIT` (value: `"USER_ROLES_CHANGED_AUDIT"`) + +* `ORG_FLEX_CONSULTING_PURCHASED` (value: `"ORG_FLEX_CONSULTING_PURCHASED"`) + +* `ORG_FLEX_CONSULTING_PURCHASE_FAILED` (value: `"ORG_FLEX_CONSULTING_PURCHASE_FAILED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserEventViewForNdsGroup.md b/docs/docs/UserEventViewForNdsGroup.md new file mode 100644 index 00000000..f19c8b69 --- /dev/null +++ b/docs/docs/UserEventViewForNdsGroup.md @@ -0,0 +1,379 @@ +# UserEventViewForNdsGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**UserEventTypeViewForNdsGroup**](UserEventTypeViewForNdsGroup.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**TargetUsername** | Pointer to **string** | Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewUserEventViewForNdsGroup + +`func NewUserEventViewForNdsGroup(created time.Time, eventTypeName UserEventTypeViewForNdsGroup, id string, ) *UserEventViewForNdsGroup` + +NewUserEventViewForNdsGroup instantiates a new UserEventViewForNdsGroup object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserEventViewForNdsGroupWithDefaults + +`func NewUserEventViewForNdsGroupWithDefaults() *UserEventViewForNdsGroup` + +NewUserEventViewForNdsGroupWithDefaults instantiates a new UserEventViewForNdsGroup object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *UserEventViewForNdsGroup) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *UserEventViewForNdsGroup) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *UserEventViewForNdsGroup) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *UserEventViewForNdsGroup) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *UserEventViewForNdsGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *UserEventViewForNdsGroup) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *UserEventViewForNdsGroup) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *UserEventViewForNdsGroup) GetEventTypeName() UserEventTypeViewForNdsGroup` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *UserEventViewForNdsGroup) GetEventTypeNameOk() (*UserEventTypeViewForNdsGroup, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *UserEventViewForNdsGroup) SetEventTypeName(v UserEventTypeViewForNdsGroup)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *UserEventViewForNdsGroup) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *UserEventViewForNdsGroup) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *UserEventViewForNdsGroup) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *UserEventViewForNdsGroup) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *UserEventViewForNdsGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserEventViewForNdsGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserEventViewForNdsGroup) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *UserEventViewForNdsGroup) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *UserEventViewForNdsGroup) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *UserEventViewForNdsGroup) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *UserEventViewForNdsGroup) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *UserEventViewForNdsGroup) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *UserEventViewForNdsGroup) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *UserEventViewForNdsGroup) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *UserEventViewForNdsGroup) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *UserEventViewForNdsGroup) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *UserEventViewForNdsGroup) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *UserEventViewForNdsGroup) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *UserEventViewForNdsGroup) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *UserEventViewForNdsGroup) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *UserEventViewForNdsGroup) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *UserEventViewForNdsGroup) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *UserEventViewForNdsGroup) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *UserEventViewForNdsGroup) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *UserEventViewForNdsGroup) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *UserEventViewForNdsGroup) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *UserEventViewForNdsGroup) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *UserEventViewForNdsGroup) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *UserEventViewForNdsGroup) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *UserEventViewForNdsGroup) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *UserEventViewForNdsGroup) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetTargetUsername + +`func (o *UserEventViewForNdsGroup) GetTargetUsername() string` + +GetTargetUsername returns the TargetUsername field if non-nil, zero value otherwise. + +### GetTargetUsernameOk + +`func (o *UserEventViewForNdsGroup) GetTargetUsernameOk() (*string, bool)` + +GetTargetUsernameOk returns a tuple with the TargetUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUsername + +`func (o *UserEventViewForNdsGroup) SetTargetUsername(v string)` + +SetTargetUsername sets TargetUsername field to given value. + +### HasTargetUsername + +`func (o *UserEventViewForNdsGroup) HasTargetUsername() bool` + +HasTargetUsername returns a boolean if a field has been set. + +### GetUserId + +`func (o *UserEventViewForNdsGroup) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *UserEventViewForNdsGroup) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *UserEventViewForNdsGroup) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *UserEventViewForNdsGroup) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *UserEventViewForNdsGroup) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *UserEventViewForNdsGroup) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *UserEventViewForNdsGroup) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *UserEventViewForNdsGroup) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserEventViewForOrg.md b/docs/docs/UserEventViewForOrg.md new file mode 100644 index 00000000..1382148c --- /dev/null +++ b/docs/docs/UserEventViewForOrg.md @@ -0,0 +1,379 @@ +# UserEventViewForOrg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKeyId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter. | [optional] [readonly] +**Created** | **time.Time** | Date and time when this event occurred. This parameter expresses its value in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\" rel=\"noopener noreferrer\">ISO 8601</a> timestamp format in UTC. | [readonly] +**EventTypeName** | [**UserEventTypeViewForOrg**](UserEventTypeViewForOrg.md) | | +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event. | [optional] [readonly] +**Id** | **string** | Unique 24-hexadecimal digit string that identifies the event. | [readonly] +**IsGlobalAdmin** | Pointer to **bool** | Flag that indicates whether a MongoDB employee triggered the specified event. | [optional] [readonly] [default to false] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] +**OrgId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization to which these events apply. | [optional] [readonly] +**PublicKey** | Pointer to **string** | Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter. | [optional] [readonly] +**Raw** | Pointer to [**Raw**](Raw.md) | | [optional] +**RemoteAddress** | Pointer to **string** | IPv4 or IPv6 address from which the user triggered this event. | [optional] [readonly] +**TargetUsername** | Pointer to **string** | Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`. | [optional] [readonly] +**UserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter. | [optional] [readonly] +**Username** | Pointer to **string** | Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter. | [optional] [readonly] + +## Methods + +### NewUserEventViewForOrg + +`func NewUserEventViewForOrg(created time.Time, eventTypeName UserEventTypeViewForOrg, id string, ) *UserEventViewForOrg` + +NewUserEventViewForOrg instantiates a new UserEventViewForOrg object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserEventViewForOrgWithDefaults + +`func NewUserEventViewForOrgWithDefaults() *UserEventViewForOrg` + +NewUserEventViewForOrgWithDefaults instantiates a new UserEventViewForOrg object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKeyId + +`func (o *UserEventViewForOrg) GetApiKeyId() string` + +GetApiKeyId returns the ApiKeyId field if non-nil, zero value otherwise. + +### GetApiKeyIdOk + +`func (o *UserEventViewForOrg) GetApiKeyIdOk() (*string, bool)` + +GetApiKeyIdOk returns a tuple with the ApiKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKeyId + +`func (o *UserEventViewForOrg) SetApiKeyId(v string)` + +SetApiKeyId sets ApiKeyId field to given value. + +### HasApiKeyId + +`func (o *UserEventViewForOrg) HasApiKeyId() bool` + +HasApiKeyId returns a boolean if a field has been set. + +### GetCreated + +`func (o *UserEventViewForOrg) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *UserEventViewForOrg) GetCreatedOk() (*time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *UserEventViewForOrg) SetCreated(v time.Time)` + +SetCreated sets Created field to given value. + + +### GetEventTypeName + +`func (o *UserEventViewForOrg) GetEventTypeName() UserEventTypeViewForOrg` + +GetEventTypeName returns the EventTypeName field if non-nil, zero value otherwise. + +### GetEventTypeNameOk + +`func (o *UserEventViewForOrg) GetEventTypeNameOk() (*UserEventTypeViewForOrg, bool)` + +GetEventTypeNameOk returns a tuple with the EventTypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventTypeName + +`func (o *UserEventViewForOrg) SetEventTypeName(v UserEventTypeViewForOrg)` + +SetEventTypeName sets EventTypeName field to given value. + + +### GetGroupId + +`func (o *UserEventViewForOrg) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *UserEventViewForOrg) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *UserEventViewForOrg) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *UserEventViewForOrg) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetId + +`func (o *UserEventViewForOrg) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserEventViewForOrg) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserEventViewForOrg) SetId(v string)` + +SetId sets Id field to given value. + + +### GetIsGlobalAdmin + +`func (o *UserEventViewForOrg) GetIsGlobalAdmin() bool` + +GetIsGlobalAdmin returns the IsGlobalAdmin field if non-nil, zero value otherwise. + +### GetIsGlobalAdminOk + +`func (o *UserEventViewForOrg) GetIsGlobalAdminOk() (*bool, bool)` + +GetIsGlobalAdminOk returns a tuple with the IsGlobalAdmin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGlobalAdmin + +`func (o *UserEventViewForOrg) SetIsGlobalAdmin(v bool)` + +SetIsGlobalAdmin sets IsGlobalAdmin field to given value. + +### HasIsGlobalAdmin + +`func (o *UserEventViewForOrg) HasIsGlobalAdmin() bool` + +HasIsGlobalAdmin returns a boolean if a field has been set. + +### GetLinks + +`func (o *UserEventViewForOrg) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *UserEventViewForOrg) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *UserEventViewForOrg) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *UserEventViewForOrg) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + +### GetOrgId + +`func (o *UserEventViewForOrg) GetOrgId() string` + +GetOrgId returns the OrgId field if non-nil, zero value otherwise. + +### GetOrgIdOk + +`func (o *UserEventViewForOrg) GetOrgIdOk() (*string, bool)` + +GetOrgIdOk returns a tuple with the OrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgId + +`func (o *UserEventViewForOrg) SetOrgId(v string)` + +SetOrgId sets OrgId field to given value. + +### HasOrgId + +`func (o *UserEventViewForOrg) HasOrgId() bool` + +HasOrgId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *UserEventViewForOrg) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *UserEventViewForOrg) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *UserEventViewForOrg) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *UserEventViewForOrg) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetRaw + +`func (o *UserEventViewForOrg) GetRaw() Raw` + +GetRaw returns the Raw field if non-nil, zero value otherwise. + +### GetRawOk + +`func (o *UserEventViewForOrg) GetRawOk() (*Raw, bool)` + +GetRawOk returns a tuple with the Raw field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaw + +`func (o *UserEventViewForOrg) SetRaw(v Raw)` + +SetRaw sets Raw field to given value. + +### HasRaw + +`func (o *UserEventViewForOrg) HasRaw() bool` + +HasRaw returns a boolean if a field has been set. + +### GetRemoteAddress + +`func (o *UserEventViewForOrg) GetRemoteAddress() string` + +GetRemoteAddress returns the RemoteAddress field if non-nil, zero value otherwise. + +### GetRemoteAddressOk + +`func (o *UserEventViewForOrg) GetRemoteAddressOk() (*string, bool)` + +GetRemoteAddressOk returns a tuple with the RemoteAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoteAddress + +`func (o *UserEventViewForOrg) SetRemoteAddress(v string)` + +SetRemoteAddress sets RemoteAddress field to given value. + +### HasRemoteAddress + +`func (o *UserEventViewForOrg) HasRemoteAddress() bool` + +HasRemoteAddress returns a boolean if a field has been set. + +### GetTargetUsername + +`func (o *UserEventViewForOrg) GetTargetUsername() string` + +GetTargetUsername returns the TargetUsername field if non-nil, zero value otherwise. + +### GetTargetUsernameOk + +`func (o *UserEventViewForOrg) GetTargetUsernameOk() (*string, bool)` + +GetTargetUsernameOk returns a tuple with the TargetUsername field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUsername + +`func (o *UserEventViewForOrg) SetTargetUsername(v string)` + +SetTargetUsername sets TargetUsername field to given value. + +### HasTargetUsername + +`func (o *UserEventViewForOrg) HasTargetUsername() bool` + +HasTargetUsername returns a boolean if a field has been set. + +### GetUserId + +`func (o *UserEventViewForOrg) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *UserEventViewForOrg) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *UserEventViewForOrg) SetUserId(v string)` + +SetUserId sets UserId field to given value. + +### HasUserId + +`func (o *UserEventViewForOrg) HasUserId() bool` + +HasUserId returns a boolean if a field has been set. + +### GetUsername + +`func (o *UserEventViewForOrg) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *UserEventViewForOrg) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *UserEventViewForOrg) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *UserEventViewForOrg) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserNotification.md b/docs/docs/UserNotification.md new file mode 100644 index 00000000..bd4488c8 --- /dev/null +++ b/docs/docs/UserNotification.md @@ -0,0 +1,181 @@ +# UserNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**EmailEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**SmsEnabled** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set: - `\"notifications.[n].typeName\" : \"ORG\"` - `\"notifications.[n].typeName\" : \"GROUP\"` - `\"notifications.[n].typeName\" : \"USER\"` | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | +**Username** | Pointer to **string** | MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`. | [optional] + +## Methods + +### NewUserNotification + +`func NewUserNotification(typeName string, ) *UserNotification` + +NewUserNotification instantiates a new UserNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserNotificationWithDefaults + +`func NewUserNotificationWithDefaults() *UserNotification` + +NewUserNotificationWithDefaults instantiates a new UserNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *UserNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *UserNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *UserNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *UserNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetEmailEnabled + +`func (o *UserNotification) GetEmailEnabled() bool` + +GetEmailEnabled returns the EmailEnabled field if non-nil, zero value otherwise. + +### GetEmailEnabledOk + +`func (o *UserNotification) GetEmailEnabledOk() (*bool, bool)` + +GetEmailEnabledOk returns a tuple with the EmailEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEnabled + +`func (o *UserNotification) SetEmailEnabled(v bool)` + +SetEmailEnabled sets EmailEnabled field to given value. + +### HasEmailEnabled + +`func (o *UserNotification) HasEmailEnabled() bool` + +HasEmailEnabled returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *UserNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *UserNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *UserNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *UserNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetSmsEnabled + +`func (o *UserNotification) GetSmsEnabled() bool` + +GetSmsEnabled returns the SmsEnabled field if non-nil, zero value otherwise. + +### GetSmsEnabledOk + +`func (o *UserNotification) GetSmsEnabledOk() (*bool, bool)` + +GetSmsEnabledOk returns a tuple with the SmsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSmsEnabled + +`func (o *UserNotification) SetSmsEnabled(v bool)` + +SetSmsEnabled sets SmsEnabled field to given value. + +### HasSmsEnabled + +`func (o *UserNotification) HasSmsEnabled() bool` + +HasSmsEnabled returns a boolean if a field has been set. + +### GetTypeName + +`func (o *UserNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *UserNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *UserNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + +### GetUsername + +`func (o *UserNotification) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *UserNotification) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *UserNotification) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *UserNotification) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserRoleAssignment.md b/docs/docs/UserRoleAssignment.md new file mode 100644 index 00000000..28386b6e --- /dev/null +++ b/docs/docs/UserRoleAssignment.md @@ -0,0 +1,82 @@ +# UserRoleAssignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiUserId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the organization API key. | [optional] [readonly] +**Roles** | Pointer to **[]string** | List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project. | [optional] + +## Methods + +### NewUserRoleAssignment + +`func NewUserRoleAssignment() *UserRoleAssignment` + +NewUserRoleAssignment instantiates a new UserRoleAssignment object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserRoleAssignmentWithDefaults + +`func NewUserRoleAssignmentWithDefaults() *UserRoleAssignment` + +NewUserRoleAssignmentWithDefaults instantiates a new UserRoleAssignment object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiUserId + +`func (o *UserRoleAssignment) GetApiUserId() string` + +GetApiUserId returns the ApiUserId field if non-nil, zero value otherwise. + +### GetApiUserIdOk + +`func (o *UserRoleAssignment) GetApiUserIdOk() (*string, bool)` + +GetApiUserIdOk returns a tuple with the ApiUserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiUserId + +`func (o *UserRoleAssignment) SetApiUserId(v string)` + +SetApiUserId sets ApiUserId field to given value. + +### HasApiUserId + +`func (o *UserRoleAssignment) HasApiUserId() bool` + +HasApiUserId returns a boolean if a field has been set. + +### GetRoles + +`func (o *UserRoleAssignment) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *UserRoleAssignment) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *UserRoleAssignment) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *UserRoleAssignment) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserScope.md b/docs/docs/UserScope.md new file mode 100644 index 00000000..3c8cf77d --- /dev/null +++ b/docs/docs/UserScope.md @@ -0,0 +1,72 @@ +# UserScope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access. | +**Type** | **string** | Category of resource that this database user can access. | + +## Methods + +### NewUserScope + +`func NewUserScope(name string, type_ string, ) *UserScope` + +NewUserScope instantiates a new UserScope object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserScopeWithDefaults + +`func NewUserScopeWithDefaults() *UserScope` + +NewUserScopeWithDefaults instantiates a new UserScope object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *UserScope) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserScope) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserScope) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *UserScope) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserScope) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserScope) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/UserSecurity.md b/docs/docs/UserSecurity.md new file mode 100644 index 00000000..969100a3 --- /dev/null +++ b/docs/docs/UserSecurity.md @@ -0,0 +1,108 @@ +# UserSecurity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerX509** | Pointer to [**CustomerX509**](CustomerX509.md) | | [optional] +**Ldap** | Pointer to [**NDSLDAP**](NDSLDAP.md) | | [optional] +**Links** | Pointer to [**[]Link**](Link.md) | List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. | [optional] [readonly] + +## Methods + +### NewUserSecurity + +`func NewUserSecurity() *UserSecurity` + +NewUserSecurity instantiates a new UserSecurity object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUserSecurityWithDefaults + +`func NewUserSecurityWithDefaults() *UserSecurity` + +NewUserSecurityWithDefaults instantiates a new UserSecurity object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCustomerX509 + +`func (o *UserSecurity) GetCustomerX509() CustomerX509` + +GetCustomerX509 returns the CustomerX509 field if non-nil, zero value otherwise. + +### GetCustomerX509Ok + +`func (o *UserSecurity) GetCustomerX509Ok() (*CustomerX509, bool)` + +GetCustomerX509Ok returns a tuple with the CustomerX509 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomerX509 + +`func (o *UserSecurity) SetCustomerX509(v CustomerX509)` + +SetCustomerX509 sets CustomerX509 field to given value. + +### HasCustomerX509 + +`func (o *UserSecurity) HasCustomerX509() bool` + +HasCustomerX509 returns a boolean if a field has been set. + +### GetLdap + +`func (o *UserSecurity) GetLdap() NDSLDAP` + +GetLdap returns the Ldap field if non-nil, zero value otherwise. + +### GetLdapOk + +`func (o *UserSecurity) GetLdapOk() (*NDSLDAP, bool)` + +GetLdapOk returns a tuple with the Ldap field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLdap + +`func (o *UserSecurity) SetLdap(v NDSLDAP)` + +SetLdap sets Ldap field to given value. + +### HasLdap + +`func (o *UserSecurity) HasLdap() bool` + +HasLdap returns a boolean if a field has been set. + +### GetLinks + +`func (o *UserSecurity) GetLinks() []Link` + +GetLinks returns the Links field if non-nil, zero value otherwise. + +### GetLinksOk + +`func (o *UserSecurity) GetLinksOk() (*[]Link, bool)` + +GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinks + +`func (o *UserSecurity) SetLinks(v []Link)` + +SetLinks sets Links field to given value. + +### HasLinks + +`func (o *UserSecurity) HasLinks() bool` + +HasLinks returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Validation.md b/docs/docs/Validation.md new file mode 100644 index 00000000..1c1107bd --- /dev/null +++ b/docs/docs/Validation.md @@ -0,0 +1,180 @@ +# Validation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the validation. | [optional] [readonly] +**ErrorMessage** | Pointer to **NullableString** | Reason why the validation job failed. | [optional] [readonly] +**GroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the project to validate. | [optional] [readonly] +**SourceGroupId** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the source project. | [optional] +**Status** | Pointer to **NullableString** | State of the specified validation job returned at the time of the request. | [optional] [readonly] + +## Methods + +### NewValidation + +`func NewValidation() *Validation` + +NewValidation instantiates a new Validation object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewValidationWithDefaults + +`func NewValidationWithDefaults() *Validation` + +NewValidationWithDefaults instantiates a new Validation object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *Validation) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Validation) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Validation) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Validation) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *Validation) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *Validation) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *Validation) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *Validation) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *Validation) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *Validation) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetGroupId + +`func (o *Validation) GetGroupId() string` + +GetGroupId returns the GroupId field if non-nil, zero value otherwise. + +### GetGroupIdOk + +`func (o *Validation) GetGroupIdOk() (*string, bool)` + +GetGroupIdOk returns a tuple with the GroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGroupId + +`func (o *Validation) SetGroupId(v string)` + +SetGroupId sets GroupId field to given value. + +### HasGroupId + +`func (o *Validation) HasGroupId() bool` + +HasGroupId returns a boolean if a field has been set. + +### GetSourceGroupId + +`func (o *Validation) GetSourceGroupId() string` + +GetSourceGroupId returns the SourceGroupId field if non-nil, zero value otherwise. + +### GetSourceGroupIdOk + +`func (o *Validation) GetSourceGroupIdOk() (*string, bool)` + +GetSourceGroupIdOk returns a tuple with the SourceGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceGroupId + +`func (o *Validation) SetSourceGroupId(v string)` + +SetSourceGroupId sets SourceGroupId field to given value. + +### HasSourceGroupId + +`func (o *Validation) HasSourceGroupId() bool` + +HasSourceGroupId returns a boolean if a field has been set. + +### GetStatus + +`func (o *Validation) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Validation) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Validation) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Validation) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *Validation) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *Validation) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/VictorOps.md b/docs/docs/VictorOps.md new file mode 100644 index 00000000..0358e3cc --- /dev/null +++ b/docs/docs/VictorOps.md @@ -0,0 +1,103 @@ +# VictorOps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | **string** | Key that allows MongoDB Cloud to access your VictorOps account. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | +**RoutingKey** | Pointer to **string** | Routing key associated with your Splunk On-Call account. | [optional] +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] + +## Methods + +### NewVictorOps + +`func NewVictorOps(apiKey string, ) *VictorOps` + +NewVictorOps instantiates a new VictorOps object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVictorOpsWithDefaults + +`func NewVictorOpsWithDefaults() *VictorOps` + +NewVictorOpsWithDefaults instantiates a new VictorOps object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetApiKey + +`func (o *VictorOps) GetApiKey() string` + +GetApiKey returns the ApiKey field if non-nil, zero value otherwise. + +### GetApiKeyOk + +`func (o *VictorOps) GetApiKeyOk() (*string, bool)` + +GetApiKeyOk returns a tuple with the ApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiKey + +`func (o *VictorOps) SetApiKey(v string)` + +SetApiKey sets ApiKey field to given value. + + +### GetRoutingKey + +`func (o *VictorOps) GetRoutingKey() string` + +GetRoutingKey returns the RoutingKey field if non-nil, zero value otherwise. + +### GetRoutingKeyOk + +`func (o *VictorOps) GetRoutingKeyOk() (*string, bool)` + +GetRoutingKeyOk returns a tuple with the RoutingKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoutingKey + +`func (o *VictorOps) SetRoutingKey(v string)` + +SetRoutingKey sets RoutingKey field to given value. + +### HasRoutingKey + +`func (o *VictorOps) HasRoutingKey() bool` + +HasRoutingKey returns a boolean if a field has been set. + +### GetType + +`func (o *VictorOps) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *VictorOps) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *VictorOps) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *VictorOps) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/VictorOpsNotification.md b/docs/docs/VictorOpsNotification.md new file mode 100644 index 00000000..4ea80c4a --- /dev/null +++ b/docs/docs/VictorOpsNotification.md @@ -0,0 +1,155 @@ +# VictorOpsNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | +**VictorOpsApiKey** | Pointer to **string** | API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. **NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you: * View or edit the alert through the Atlas UI. * Query the alert for the notification through the Atlas Administration API. | [optional] +**VictorOpsRoutingKey** | Pointer to **string** | Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it. | [optional] + +## Methods + +### NewVictorOpsNotification + +`func NewVictorOpsNotification(typeName string, ) *VictorOpsNotification` + +NewVictorOpsNotification instantiates a new VictorOpsNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewVictorOpsNotificationWithDefaults + +`func NewVictorOpsNotificationWithDefaults() *VictorOpsNotification` + +NewVictorOpsNotificationWithDefaults instantiates a new VictorOpsNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *VictorOpsNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *VictorOpsNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *VictorOpsNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *VictorOpsNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *VictorOpsNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *VictorOpsNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *VictorOpsNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *VictorOpsNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *VictorOpsNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *VictorOpsNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *VictorOpsNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + +### GetVictorOpsApiKey + +`func (o *VictorOpsNotification) GetVictorOpsApiKey() string` + +GetVictorOpsApiKey returns the VictorOpsApiKey field if non-nil, zero value otherwise. + +### GetVictorOpsApiKeyOk + +`func (o *VictorOpsNotification) GetVictorOpsApiKeyOk() (*string, bool)` + +GetVictorOpsApiKeyOk returns a tuple with the VictorOpsApiKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVictorOpsApiKey + +`func (o *VictorOpsNotification) SetVictorOpsApiKey(v string)` + +SetVictorOpsApiKey sets VictorOpsApiKey field to given value. + +### HasVictorOpsApiKey + +`func (o *VictorOpsNotification) HasVictorOpsApiKey() bool` + +HasVictorOpsApiKey returns a boolean if a field has been set. + +### GetVictorOpsRoutingKey + +`func (o *VictorOpsNotification) GetVictorOpsRoutingKey() string` + +GetVictorOpsRoutingKey returns the VictorOpsRoutingKey field if non-nil, zero value otherwise. + +### GetVictorOpsRoutingKeyOk + +`func (o *VictorOpsNotification) GetVictorOpsRoutingKeyOk() (*string, bool)` + +GetVictorOpsRoutingKeyOk returns a tuple with the VictorOpsRoutingKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVictorOpsRoutingKey + +`func (o *VictorOpsNotification) SetVictorOpsRoutingKey(v string)` + +SetVictorOpsRoutingKey sets VictorOpsRoutingKey field to given value. + +### HasVictorOpsRoutingKey + +`func (o *VictorOpsNotification) HasVictorOpsRoutingKey() bool` + +HasVictorOpsRoutingKey returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/Webhook.md b/docs/docs/Webhook.md new file mode 100644 index 00000000..0cb1d7d9 --- /dev/null +++ b/docs/docs/Webhook.md @@ -0,0 +1,103 @@ +# Webhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Secret** | Pointer to **string** | An optional field returned if your webhook is configured with a secret. **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted. | [optional] +**Type** | Pointer to **string** | Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. | [optional] +**Url** | **string** | Endpoint web address to which MongoDB Cloud sends notifications. **NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted. | + +## Methods + +### NewWebhook + +`func NewWebhook(url string, ) *Webhook` + +NewWebhook instantiates a new Webhook object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewWebhookWithDefaults + +`func NewWebhookWithDefaults() *Webhook` + +NewWebhookWithDefaults instantiates a new Webhook object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetSecret + +`func (o *Webhook) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *Webhook) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *Webhook) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *Webhook) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetType + +`func (o *Webhook) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Webhook) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Webhook) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Webhook) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUrl + +`func (o *Webhook) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *Webhook) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *Webhook) SetUrl(v string)` + +SetUrl sets Url field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/WebhookNotification.md b/docs/docs/WebhookNotification.md new file mode 100644 index 00000000..38a93893 --- /dev/null +++ b/docs/docs/WebhookNotification.md @@ -0,0 +1,155 @@ +# WebhookNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DelayMin** | Pointer to **int** | Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. | [optional] +**IntervalMin** | Pointer to **int** | Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert. PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services. | [optional] +**TypeName** | **string** | Human-readable label that displays the alert notification type. | +**WebhookSecret** | Pointer to **string** | Authentication secret for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookSecret` to a non-empty string * You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted. | [optional] +**WebhookUrl** | Pointer to **string** | Target URL for a webhook-based alert. Atlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either: * You set `notification.[n].webhookURL` to a non-empty string * You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration) **NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted. | [optional] + +## Methods + +### NewWebhookNotification + +`func NewWebhookNotification(typeName string, ) *WebhookNotification` + +NewWebhookNotification instantiates a new WebhookNotification object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewWebhookNotificationWithDefaults + +`func NewWebhookNotificationWithDefaults() *WebhookNotification` + +NewWebhookNotificationWithDefaults instantiates a new WebhookNotification object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDelayMin + +`func (o *WebhookNotification) GetDelayMin() int` + +GetDelayMin returns the DelayMin field if non-nil, zero value otherwise. + +### GetDelayMinOk + +`func (o *WebhookNotification) GetDelayMinOk() (*int, bool)` + +GetDelayMinOk returns a tuple with the DelayMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelayMin + +`func (o *WebhookNotification) SetDelayMin(v int)` + +SetDelayMin sets DelayMin field to given value. + +### HasDelayMin + +`func (o *WebhookNotification) HasDelayMin() bool` + +HasDelayMin returns a boolean if a field has been set. + +### GetIntervalMin + +`func (o *WebhookNotification) GetIntervalMin() int` + +GetIntervalMin returns the IntervalMin field if non-nil, zero value otherwise. + +### GetIntervalMinOk + +`func (o *WebhookNotification) GetIntervalMinOk() (*int, bool)` + +GetIntervalMinOk returns a tuple with the IntervalMin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIntervalMin + +`func (o *WebhookNotification) SetIntervalMin(v int)` + +SetIntervalMin sets IntervalMin field to given value. + +### HasIntervalMin + +`func (o *WebhookNotification) HasIntervalMin() bool` + +HasIntervalMin returns a boolean if a field has been set. + +### GetTypeName + +`func (o *WebhookNotification) GetTypeName() string` + +GetTypeName returns the TypeName field if non-nil, zero value otherwise. + +### GetTypeNameOk + +`func (o *WebhookNotification) GetTypeNameOk() (*string, bool)` + +GetTypeNameOk returns a tuple with the TypeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeName + +`func (o *WebhookNotification) SetTypeName(v string)` + +SetTypeName sets TypeName field to given value. + + +### GetWebhookSecret + +`func (o *WebhookNotification) GetWebhookSecret() string` + +GetWebhookSecret returns the WebhookSecret field if non-nil, zero value otherwise. + +### GetWebhookSecretOk + +`func (o *WebhookNotification) GetWebhookSecretOk() (*string, bool)` + +GetWebhookSecretOk returns a tuple with the WebhookSecret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWebhookSecret + +`func (o *WebhookNotification) SetWebhookSecret(v string)` + +SetWebhookSecret sets WebhookSecret field to given value. + +### HasWebhookSecret + +`func (o *WebhookNotification) HasWebhookSecret() bool` + +HasWebhookSecret returns a boolean if a field has been set. + +### GetWebhookUrl + +`func (o *WebhookNotification) GetWebhookUrl() string` + +GetWebhookUrl returns the WebhookUrl field if non-nil, zero value otherwise. + +### GetWebhookUrlOk + +`func (o *WebhookNotification) GetWebhookUrlOk() (*string, bool)` + +GetWebhookUrlOk returns a tuple with the WebhookUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWebhookUrl + +`func (o *WebhookNotification) SetWebhookUrl(v string)` + +SetWebhookUrl sets WebhookUrl field to given value. + +### HasWebhookUrl + +`func (o *WebhookNotification) HasWebhookUrl() bool` + +HasWebhookUrl returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/WeeklySchedule.md b/docs/docs/WeeklySchedule.md new file mode 100644 index 00000000..f5218bb1 --- /dev/null +++ b/docs/docs/WeeklySchedule.md @@ -0,0 +1,181 @@ +# WeeklySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DayOfWeek** | Pointer to **int** | Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`). | [optional] +**EndHour** | Pointer to **int** | Hour of the day when the scheduled window to run one online archive ends. | [optional] +**EndMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive ends. | [optional] +**StartHour** | Pointer to **int** | Hour of the day when the when the scheduled window to run one online archive starts. | [optional] +**StartMinute** | Pointer to **int** | Minute of the hour when the scheduled window to run one online archive starts. | [optional] +**Type** | **string** | | + +## Methods + +### NewWeeklySchedule + +`func NewWeeklySchedule(type_ string, ) *WeeklySchedule` + +NewWeeklySchedule instantiates a new WeeklySchedule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewWeeklyScheduleWithDefaults + +`func NewWeeklyScheduleWithDefaults() *WeeklySchedule` + +NewWeeklyScheduleWithDefaults instantiates a new WeeklySchedule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDayOfWeek + +`func (o *WeeklySchedule) GetDayOfWeek() int` + +GetDayOfWeek returns the DayOfWeek field if non-nil, zero value otherwise. + +### GetDayOfWeekOk + +`func (o *WeeklySchedule) GetDayOfWeekOk() (*int, bool)` + +GetDayOfWeekOk returns a tuple with the DayOfWeek field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDayOfWeek + +`func (o *WeeklySchedule) SetDayOfWeek(v int)` + +SetDayOfWeek sets DayOfWeek field to given value. + +### HasDayOfWeek + +`func (o *WeeklySchedule) HasDayOfWeek() bool` + +HasDayOfWeek returns a boolean if a field has been set. + +### GetEndHour + +`func (o *WeeklySchedule) GetEndHour() int` + +GetEndHour returns the EndHour field if non-nil, zero value otherwise. + +### GetEndHourOk + +`func (o *WeeklySchedule) GetEndHourOk() (*int, bool)` + +GetEndHourOk returns a tuple with the EndHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndHour + +`func (o *WeeklySchedule) SetEndHour(v int)` + +SetEndHour sets EndHour field to given value. + +### HasEndHour + +`func (o *WeeklySchedule) HasEndHour() bool` + +HasEndHour returns a boolean if a field has been set. + +### GetEndMinute + +`func (o *WeeklySchedule) GetEndMinute() int` + +GetEndMinute returns the EndMinute field if non-nil, zero value otherwise. + +### GetEndMinuteOk + +`func (o *WeeklySchedule) GetEndMinuteOk() (*int, bool)` + +GetEndMinuteOk returns a tuple with the EndMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndMinute + +`func (o *WeeklySchedule) SetEndMinute(v int)` + +SetEndMinute sets EndMinute field to given value. + +### HasEndMinute + +`func (o *WeeklySchedule) HasEndMinute() bool` + +HasEndMinute returns a boolean if a field has been set. + +### GetStartHour + +`func (o *WeeklySchedule) GetStartHour() int` + +GetStartHour returns the StartHour field if non-nil, zero value otherwise. + +### GetStartHourOk + +`func (o *WeeklySchedule) GetStartHourOk() (*int, bool)` + +GetStartHourOk returns a tuple with the StartHour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartHour + +`func (o *WeeklySchedule) SetStartHour(v int)` + +SetStartHour sets StartHour field to given value. + +### HasStartHour + +`func (o *WeeklySchedule) HasStartHour() bool` + +HasStartHour returns a boolean if a field has been set. + +### GetStartMinute + +`func (o *WeeklySchedule) GetStartMinute() int` + +GetStartMinute returns the StartMinute field if non-nil, zero value otherwise. + +### GetStartMinuteOk + +`func (o *WeeklySchedule) GetStartMinuteOk() (*int, bool)` + +GetStartMinuteOk returns a tuple with the StartMinute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartMinute + +`func (o *WeeklySchedule) SetStartMinute(v int)` + +SetStartMinute sets StartMinute field to given value. + +### HasStartMinute + +`func (o *WeeklySchedule) HasStartMinute() bool` + +HasStartMinute returns a boolean if a field has been set. + +### GetType + +`func (o *WeeklySchedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WeeklySchedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WeeklySchedule) SetType(v string)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/X509AuthenticationApi.md b/docs/docs/X509AuthenticationApi.md new file mode 100644 index 00000000..6436957c --- /dev/null +++ b/docs/docs/X509AuthenticationApi.md @@ -0,0 +1,245 @@ +# \X509AuthenticationApi + +All URIs are relative to *https://cloud.mongodb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateDatabaseUserCertificate**](X509AuthenticationApi.md#CreateDatabaseUserCertificate) | **Post** /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs | Create One X.509 Certificate for One MongoDB User +[**DisableCustomerManagedX509**](X509AuthenticationApi.md#DisableCustomerManagedX509) | **Delete** /api/atlas/v2/groups/{groupId}/userSecurity/customerX509 | Disable Customer-Managed X.509 +[**ListDatabaseUserCertificates**](X509AuthenticationApi.md#ListDatabaseUserCertificates) | **Get** /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs | Return All X.509 Certificates Assigned to One MongoDB User + + + +## CreateDatabaseUserCertificate + +> CreateDatabaseUserCertificate(ctx, groupId, username).UserCert(userCert).Execute() + +Create One X.509 Certificate for One MongoDB User + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + username := "username_example" // string | + userCert := *openapiclient.NewUserCert() // UserCert | + + r, err := sdk.X509AuthenticationApi.CreateDatabaseUserCertificate(context.Background(), groupId, username).UserCert(userCert).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `X509AuthenticationApi.CreateDatabaseUserCertificate``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**username** | **string** | Human-readable label that represents the MongoDB database user account for whom to create a certificate. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDatabaseUserCertificateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **userCert** | [**UserCert**](UserCert.md) | Generates one X.509 certificate for the specified MongoDB user. | + +### Return type + + (empty response body) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: application/vnd.atlas.2023-01-01+json +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DisableCustomerManagedX509 + +> UserSecurity DisableCustomerManagedX509(ctx, groupId).Execute() + +Disable Customer-Managed X.509 + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + + resp, r, err := sdk.X509AuthenticationApi.DisableCustomerManagedX509(context.Background(), groupId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `X509AuthenticationApi.DisableCustomerManagedX509``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `DisableCustomerManagedX509`: UserSecurity + fmt.Fprintf(os.Stdout, "Response from `X509AuthenticationApi.DisableCustomerManagedX509`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableCustomerManagedX509Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**UserSecurity**](UserSecurity.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ListDatabaseUserCertificates + +> PaginatedUserCert ListDatabaseUserCertificates(ctx, groupId, username).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + +Return All X.509 Certificates Assigned to One MongoDB User + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + "go.mongodb.org/atlas-sdk/admin" +) + +func main() { + apiKey := os.Getenv("MDB_API_KEY") + apiSecret := os.Getenv("MDB_API_SECRET") + + sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret)) + + groupId := "32b6e34b3d91647abb20e7b8" // string | + username := "username_example" // string | + includeCount := true // bool | (optional) (default to true) + itemsPerPage := int(100) // int | (optional) (default to 100) + pageNum := int(1) // int | (optional) (default to 1) + + resp, r, err := sdk.X509AuthenticationApi.ListDatabaseUserCertificates(context.Background(), groupId, username).IncludeCount(includeCount).ItemsPerPage(itemsPerPage).PageNum(pageNum).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `X509AuthenticationApi.ListDatabaseUserCertificates``: %v\n", err) + apiError := admin.AsError(err) + fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError) + } + // response from `ListDatabaseUserCertificates`: PaginatedUserCert + fmt.Fprintf(os.Stdout, "Response from `X509AuthenticationApi.ListDatabaseUserCertificates`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**groupId** | **string** | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. | +**username** | **string** | Human-readable label that represents the MongoDB database user account whose certificates you want to return. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDatabaseUserCertificatesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCount** | **bool** | Flag that indicates whether the response returns the total number of items (**totalCount**) in the response. | [default to true] + **itemsPerPage** | **int** | Number of items that the response returns per page. | [default to 100] + **pageNum** | **int** | Number of the page that displays the current set of the total objects that the response returns. | [default to 1] + +### Return type + +[**PaginatedUserCert**](PaginatedUserCert.md) + +### Authorization +[DigestAuth](../README.md#Authentication) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/vnd.atlas.2023-01-01+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/docs/docs/X509Certificate.md b/docs/docs/X509Certificate.md new file mode 100644 index 00000000..2dde8e28 --- /dev/null +++ b/docs/docs/X509Certificate.md @@ -0,0 +1,108 @@ +# X509Certificate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Content** | Pointer to **string** | | [optional] +**NotAfter** | Pointer to **time.Time** | | [optional] +**NotBefore** | Pointer to **time.Time** | | [optional] + +## Methods + +### NewX509Certificate + +`func NewX509Certificate() *X509Certificate` + +NewX509Certificate instantiates a new X509Certificate object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewX509CertificateWithDefaults + +`func NewX509CertificateWithDefaults() *X509Certificate` + +NewX509CertificateWithDefaults instantiates a new X509Certificate object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContent + +`func (o *X509Certificate) GetContent() string` + +GetContent returns the Content field if non-nil, zero value otherwise. + +### GetContentOk + +`func (o *X509Certificate) GetContentOk() (*string, bool)` + +GetContentOk returns a tuple with the Content field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContent + +`func (o *X509Certificate) SetContent(v string)` + +SetContent sets Content field to given value. + +### HasContent + +`func (o *X509Certificate) HasContent() bool` + +HasContent returns a boolean if a field has been set. + +### GetNotAfter + +`func (o *X509Certificate) GetNotAfter() time.Time` + +GetNotAfter returns the NotAfter field if non-nil, zero value otherwise. + +### GetNotAfterOk + +`func (o *X509Certificate) GetNotAfterOk() (*time.Time, bool)` + +GetNotAfterOk returns a tuple with the NotAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotAfter + +`func (o *X509Certificate) SetNotAfter(v time.Time)` + +SetNotAfter sets NotAfter field to given value. + +### HasNotAfter + +`func (o *X509Certificate) HasNotAfter() bool` + +HasNotAfter returns a boolean if a field has been set. + +### GetNotBefore + +`func (o *X509Certificate) GetNotBefore() time.Time` + +GetNotBefore returns the NotBefore field if non-nil, zero value otherwise. + +### GetNotBeforeOk + +`func (o *X509Certificate) GetNotBeforeOk() (*time.Time, bool)` + +GetNotBeforeOk returns a tuple with the NotBefore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotBefore + +`func (o *X509Certificate) SetNotBefore(v time.Time)` + +SetNotBefore sets NotBefore field to given value. + +### HasNotBefore + +`func (o *X509Certificate) HasNotBefore() bool` + +HasNotBefore returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/X509CertificateView.md b/docs/docs/X509CertificateView.md new file mode 100644 index 00000000..11645d7c --- /dev/null +++ b/docs/docs/X509CertificateView.md @@ -0,0 +1,82 @@ +# X509CertificateView + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotAfter** | Pointer to **time.Time** | Latest date that the certificate is valid. | [optional] +**NotBefore** | Pointer to **time.Time** | Earliest date that the certificate is valid. | [optional] + +## Methods + +### NewX509CertificateView + +`func NewX509CertificateView() *X509CertificateView` + +NewX509CertificateView instantiates a new X509CertificateView object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewX509CertificateViewWithDefaults + +`func NewX509CertificateViewWithDefaults() *X509CertificateView` + +NewX509CertificateViewWithDefaults instantiates a new X509CertificateView object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNotAfter + +`func (o *X509CertificateView) GetNotAfter() time.Time` + +GetNotAfter returns the NotAfter field if non-nil, zero value otherwise. + +### GetNotAfterOk + +`func (o *X509CertificateView) GetNotAfterOk() (*time.Time, bool)` + +GetNotAfterOk returns a tuple with the NotAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotAfter + +`func (o *X509CertificateView) SetNotAfter(v time.Time)` + +SetNotAfter sets NotAfter field to given value. + +### HasNotAfter + +`func (o *X509CertificateView) HasNotAfter() bool` + +HasNotAfter returns a boolean if a field has been set. + +### GetNotBefore + +`func (o *X509CertificateView) GetNotBefore() time.Time` + +GetNotBefore returns the NotBefore field if non-nil, zero value otherwise. + +### GetNotBeforeOk + +`func (o *X509CertificateView) GetNotBeforeOk() (*time.Time, bool)` + +GetNotBeforeOk returns a tuple with the NotBefore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotBefore + +`func (o *X509CertificateView) SetNotBefore(v time.Time)` + +SetNotBefore sets NotBefore field to given value. + +### HasNotBefore + +`func (o *X509CertificateView) HasNotBefore() bool` + +HasNotBefore returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/docs/ZoneMapping.md b/docs/docs/ZoneMapping.md new file mode 100644 index 00000000..433f249e --- /dev/null +++ b/docs/docs/ZoneMapping.md @@ -0,0 +1,72 @@ +# ZoneMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Location** | **string** | Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible. | +**Zone** | **string** | Human-readable label that identifies the zone in your global cluster. This zone maps to a location code. | + +## Methods + +### NewZoneMapping + +`func NewZoneMapping(location string, zone string, ) *ZoneMapping` + +NewZoneMapping instantiates a new ZoneMapping object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewZoneMappingWithDefaults + +`func NewZoneMappingWithDefaults() *ZoneMapping` + +NewZoneMappingWithDefaults instantiates a new ZoneMapping object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLocation + +`func (o *ZoneMapping) GetLocation() string` + +GetLocation returns the Location field if non-nil, zero value otherwise. + +### GetLocationOk + +`func (o *ZoneMapping) GetLocationOk() (*string, bool)` + +GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocation + +`func (o *ZoneMapping) SetLocation(v string)` + +SetLocation sets Location field to given value. + + +### GetZone + +`func (o *ZoneMapping) GetZone() string` + +GetZone returns the Zone field if non-nil, zero value otherwise. + +### GetZoneOk + +`func (o *ZoneMapping) GetZoneOk() (*string, bool)` + +GetZoneOk returns a tuple with the Zone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetZone + +`func (o *ZoneMapping) SetZone(v string)` + +SetZone sets Zone field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/tools/config/go-templates/api_doc.mustache b/tools/config/go-templates/api_doc.mustache index 1858c6fc..0d032129 100644 --- a/tools/config/go-templates/api_doc.mustache +++ b/tools/config/go-templates/api_doc.mustache @@ -79,7 +79,7 @@ Name | Type | Description | Notes ### Authorization {{!X-GEN-CUSTOM}} -[DigestAuth](../../README.md) +[DigestAuth](../README.md#Authentication) ### HTTP request headers