Skip to content

Commit 3707f8e

Browse files
wtrockiwtrocki
authored
chore: regenerated documentation (#10)
1 parent 4d0b0bf commit 3707f8e

File tree

589 files changed

+116820
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

589 files changed

+116820
-3
lines changed

‎docs/docs/AWSAutoScaling.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# AWSAutoScaling
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Compute** | Pointer to [**AWSComputeAutoScaling**](AWSComputeAutoScaling.md) | | [optional]
8+
9+
## Methods
10+
11+
### NewAWSAutoScaling
12+
13+
`func NewAWSAutoScaling() *AWSAutoScaling`
14+
15+
NewAWSAutoScaling instantiates a new AWSAutoScaling object
16+
This constructor will assign default values to properties that have it defined,
17+
and makes sure properties required by API are set, but the set of arguments
18+
will change when the set of required properties is changed
19+
20+
### NewAWSAutoScalingWithDefaults
21+
22+
`func NewAWSAutoScalingWithDefaults() *AWSAutoScaling`
23+
24+
NewAWSAutoScalingWithDefaults instantiates a new AWSAutoScaling object
25+
This constructor will only assign default values to properties that have it defined,
26+
but it doesn't guarantee that properties required by API are set
27+
28+
### GetCompute
29+
30+
`func (o *AWSAutoScaling) GetCompute() AWSComputeAutoScaling`
31+
32+
GetCompute returns the Compute field if non-nil, zero value otherwise.
33+
34+
### GetComputeOk
35+
36+
`func (o *AWSAutoScaling) GetComputeOk() (*AWSComputeAutoScaling, bool)`
37+
38+
GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise
39+
and a boolean to check if the value has been set.
40+
41+
### SetCompute
42+
43+
`func (o *AWSAutoScaling) SetCompute(v AWSComputeAutoScaling)`
44+
45+
SetCompute sets Compute field to given value.
46+
47+
### HasCompute
48+
49+
`func (o *AWSAutoScaling) HasCompute() bool`
50+
51+
HasCompute returns a boolean if a field has been set.
52+
53+
54+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
55+
56+

‎docs/docs/AWSCloudProviderContainer.md

+181
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# AWSCloudProviderContainer
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**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]
8+
**RegionName** | **string** | Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. |
9+
**VpcId** | Pointer to **string** | Unique string that identifies the MongoDB Cloud VPC on AWS. | [optional] [readonly]
10+
**Id** | Pointer to **string** | Unique 24-hexadecimal digit string that identifies the network peering container. | [optional] [readonly]
11+
**ProviderName** | Pointer to **string** | Cloud service provider that serves the requested network peering containers. | [optional]
12+
**Provisioned** | Pointer to **bool** | Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container. | [optional] [readonly]
13+
14+
## Methods
15+
16+
### NewAWSCloudProviderContainer
17+
18+
`func NewAWSCloudProviderContainer(regionName string, ) *AWSCloudProviderContainer`
19+
20+
NewAWSCloudProviderContainer instantiates a new AWSCloudProviderContainer object
21+
This constructor will assign default values to properties that have it defined,
22+
and makes sure properties required by API are set, but the set of arguments
23+
will change when the set of required properties is changed
24+
25+
### NewAWSCloudProviderContainerWithDefaults
26+
27+
`func NewAWSCloudProviderContainerWithDefaults() *AWSCloudProviderContainer`
28+
29+
NewAWSCloudProviderContainerWithDefaults instantiates a new AWSCloudProviderContainer object
30+
This constructor will only assign default values to properties that have it defined,
31+
but it doesn't guarantee that properties required by API are set
32+
33+
### GetAtlasCidrBlock
34+
35+
`func (o *AWSCloudProviderContainer) GetAtlasCidrBlock() string`
36+
37+
GetAtlasCidrBlock returns the AtlasCidrBlock field if non-nil, zero value otherwise.
38+
39+
### GetAtlasCidrBlockOk
40+
41+
`func (o *AWSCloudProviderContainer) GetAtlasCidrBlockOk() (*string, bool)`
42+
43+
GetAtlasCidrBlockOk returns a tuple with the AtlasCidrBlock field if it's non-nil, zero value otherwise
44+
and a boolean to check if the value has been set.
45+
46+
### SetAtlasCidrBlock
47+
48+
`func (o *AWSCloudProviderContainer) SetAtlasCidrBlock(v string)`
49+
50+
SetAtlasCidrBlock sets AtlasCidrBlock field to given value.
51+
52+
### HasAtlasCidrBlock
53+
54+
`func (o *AWSCloudProviderContainer) HasAtlasCidrBlock() bool`
55+
56+
HasAtlasCidrBlock returns a boolean if a field has been set.
57+
58+
### GetRegionName
59+
60+
`func (o *AWSCloudProviderContainer) GetRegionName() string`
61+
62+
GetRegionName returns the RegionName field if non-nil, zero value otherwise.
63+
64+
### GetRegionNameOk
65+
66+
`func (o *AWSCloudProviderContainer) GetRegionNameOk() (*string, bool)`
67+
68+
GetRegionNameOk returns a tuple with the RegionName field if it's non-nil, zero value otherwise
69+
and a boolean to check if the value has been set.
70+
71+
### SetRegionName
72+
73+
`func (o *AWSCloudProviderContainer) SetRegionName(v string)`
74+
75+
SetRegionName sets RegionName field to given value.
76+
77+
78+
### GetVpcId
79+
80+
`func (o *AWSCloudProviderContainer) GetVpcId() string`
81+
82+
GetVpcId returns the VpcId field if non-nil, zero value otherwise.
83+
84+
### GetVpcIdOk
85+
86+
`func (o *AWSCloudProviderContainer) GetVpcIdOk() (*string, bool)`
87+
88+
GetVpcIdOk returns a tuple with the VpcId field if it's non-nil, zero value otherwise
89+
and a boolean to check if the value has been set.
90+
91+
### SetVpcId
92+
93+
`func (o *AWSCloudProviderContainer) SetVpcId(v string)`
94+
95+
SetVpcId sets VpcId field to given value.
96+
97+
### HasVpcId
98+
99+
`func (o *AWSCloudProviderContainer) HasVpcId() bool`
100+
101+
HasVpcId returns a boolean if a field has been set.
102+
103+
### GetId
104+
105+
`func (o *AWSCloudProviderContainer) GetId() string`
106+
107+
GetId returns the Id field if non-nil, zero value otherwise.
108+
109+
### GetIdOk
110+
111+
`func (o *AWSCloudProviderContainer) GetIdOk() (*string, bool)`
112+
113+
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
114+
and a boolean to check if the value has been set.
115+
116+
### SetId
117+
118+
`func (o *AWSCloudProviderContainer) SetId(v string)`
119+
120+
SetId sets Id field to given value.
121+
122+
### HasId
123+
124+
`func (o *AWSCloudProviderContainer) HasId() bool`
125+
126+
HasId returns a boolean if a field has been set.
127+
128+
### GetProviderName
129+
130+
`func (o *AWSCloudProviderContainer) GetProviderName() string`
131+
132+
GetProviderName returns the ProviderName field if non-nil, zero value otherwise.
133+
134+
### GetProviderNameOk
135+
136+
`func (o *AWSCloudProviderContainer) GetProviderNameOk() (*string, bool)`
137+
138+
GetProviderNameOk returns a tuple with the ProviderName field if it's non-nil, zero value otherwise
139+
and a boolean to check if the value has been set.
140+
141+
### SetProviderName
142+
143+
`func (o *AWSCloudProviderContainer) SetProviderName(v string)`
144+
145+
SetProviderName sets ProviderName field to given value.
146+
147+
### HasProviderName
148+
149+
`func (o *AWSCloudProviderContainer) HasProviderName() bool`
150+
151+
HasProviderName returns a boolean if a field has been set.
152+
153+
### GetProvisioned
154+
155+
`func (o *AWSCloudProviderContainer) GetProvisioned() bool`
156+
157+
GetProvisioned returns the Provisioned field if non-nil, zero value otherwise.
158+
159+
### GetProvisionedOk
160+
161+
`func (o *AWSCloudProviderContainer) GetProvisionedOk() (*bool, bool)`
162+
163+
GetProvisionedOk returns a tuple with the Provisioned field if it's non-nil, zero value otherwise
164+
and a boolean to check if the value has been set.
165+
166+
### SetProvisioned
167+
168+
`func (o *AWSCloudProviderContainer) SetProvisioned(v bool)`
169+
170+
SetProvisioned sets Provisioned field to given value.
171+
172+
### HasProvisioned
173+
174+
`func (o *AWSCloudProviderContainer) HasProvisioned() bool`
175+
176+
HasProvisioned returns a boolean if a field has been set.
177+
178+
179+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
180+
181+

‎docs/docs/AWSClustersDNSApi.md

+160
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# \AWSClustersDNSApi
2+
3+
All URIs are relative to *https://cloud.mongodb.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**GetAWSCustomDNS**](AWSClustersDNSApi.md#GetAWSCustomDNS) | **Get** /api/atlas/v2/groups/{groupId}/awsCustomDNS | Return One Custom DNS Configuration for Atlas Clusters on AWS
8+
[**ToggleAWSCustomDNS**](AWSClustersDNSApi.md#ToggleAWSCustomDNS) | **Patch** /api/atlas/v2/groups/{groupId}/awsCustomDNS | Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS
9+
10+
11+
12+
## GetAWSCustomDNS
13+
14+
> AWSCustomDNSEnabled GetAWSCustomDNS(ctx, groupId).Execute()
15+
16+
Return One Custom DNS Configuration for Atlas Clusters on AWS
17+
18+
19+
20+
### Example
21+
22+
```go
23+
package main
24+
25+
import (
26+
"context"
27+
"fmt"
28+
"os"
29+
30+
"go.mongodb.org/atlas-sdk/admin"
31+
)
32+
33+
func main() {
34+
apiKey := os.Getenv("MDB_API_KEY")
35+
apiSecret := os.Getenv("MDB_API_SECRET")
36+
37+
sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret))
38+
39+
groupId := "32b6e34b3d91647abb20e7b8" // string |
40+
41+
resp, r, err := sdk.AWSClustersDNSApi.GetAWSCustomDNS(context.Background(), groupId).Execute()
42+
if err != nil {
43+
fmt.Fprintf(os.Stderr, "Error when calling `AWSClustersDNSApi.GetAWSCustomDNS``: %v\n", err)
44+
apiError := admin.AsError(err)
45+
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
46+
}
47+
// response from `GetAWSCustomDNS`: AWSCustomDNSEnabled
48+
fmt.Fprintf(os.Stdout, "Response from `AWSClustersDNSApi.GetAWSCustomDNS`: %v\n", resp)
49+
}
50+
```
51+
52+
### Path Parameters
53+
54+
55+
Name | Type | Description | Notes
56+
------------- | ------------- | ------------- | -------------
57+
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
58+
**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. |
59+
60+
### Other Parameters
61+
62+
Other parameters are passed through a pointer to a apiGetAWSCustomDNSRequest struct via the builder pattern
63+
64+
65+
Name | Type | Description | Notes
66+
------------- | ------------- | ------------- | -------------
67+
68+
69+
### Return type
70+
71+
[**AWSCustomDNSEnabled**](AWSCustomDNSEnabled.md)
72+
73+
### Authorization
74+
[DigestAuth](../README.md#Authentication)
75+
76+
### HTTP request headers
77+
78+
- **Content-Type**: Not defined
79+
- **Accept**: application/vnd.atlas.2023-01-01+json, application/json
80+
81+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
82+
[[Back to Model list]](../README.md#documentation-for-models)
83+
[[Back to README]](../README.md)
84+
85+
86+
## ToggleAWSCustomDNS
87+
88+
> AWSCustomDNSEnabled ToggleAWSCustomDNS(ctx, groupId).AWSCustomDNSEnabled(aWSCustomDNSEnabled).Execute()
89+
90+
Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS
91+
92+
93+
94+
### Example
95+
96+
```go
97+
package main
98+
99+
import (
100+
"context"
101+
"fmt"
102+
"os"
103+
104+
"go.mongodb.org/atlas-sdk/admin"
105+
)
106+
107+
func main() {
108+
apiKey := os.Getenv("MDB_API_KEY")
109+
apiSecret := os.Getenv("MDB_API_SECRET")
110+
111+
sdk := admin.NewClient(admin.UseDigestAuth(apiKey, apiSecret))
112+
113+
groupId := "32b6e34b3d91647abb20e7b8" // string |
114+
aWSCustomDNSEnabled := *openapiclient.NewAWSCustomDNSEnabled(false) // AWSCustomDNSEnabled |
115+
116+
resp, r, err := sdk.AWSClustersDNSApi.ToggleAWSCustomDNS(context.Background(), groupId).AWSCustomDNSEnabled(aWSCustomDNSEnabled).Execute()
117+
if err != nil {
118+
fmt.Fprintf(os.Stderr, "Error when calling `AWSClustersDNSApi.ToggleAWSCustomDNS``: %v\n", err)
119+
apiError := admin.AsError(err)
120+
fmt.Fprintf(os.Stderr, "Error obj: %v\n", apiError)
121+
}
122+
// response from `ToggleAWSCustomDNS`: AWSCustomDNSEnabled
123+
fmt.Fprintf(os.Stdout, "Response from `AWSClustersDNSApi.ToggleAWSCustomDNS`: %v\n", resp)
124+
}
125+
```
126+
127+
### Path Parameters
128+
129+
130+
Name | Type | Description | Notes
131+
------------- | ------------- | ------------- | -------------
132+
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
133+
**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. |
134+
135+
### Other Parameters
136+
137+
Other parameters are passed through a pointer to a apiToggleAWSCustomDNSRequest struct via the builder pattern
138+
139+
140+
Name | Type | Description | Notes
141+
------------- | ------------- | ------------- | -------------
142+
143+
**aWSCustomDNSEnabled** | [**AWSCustomDNSEnabled**](AWSCustomDNSEnabled.md) | Enables or disables the custom DNS configuration for AWS clusters in the specified project. |
144+
145+
### Return type
146+
147+
[**AWSCustomDNSEnabled**](AWSCustomDNSEnabled.md)
148+
149+
### Authorization
150+
[DigestAuth](../README.md#Authentication)
151+
152+
### HTTP request headers
153+
154+
- **Content-Type**: application/vnd.atlas.2023-01-01+json
155+
- **Accept**: application/vnd.atlas.2023-01-01+json, application/json
156+
157+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
158+
[[Back to Model list]](../README.md#documentation-for-models)
159+
[[Back to README]](../README.md)
160+

0 commit comments

Comments
 (0)