Skip to content

Commit

Permalink
chore: regenerated documentation (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
wtrocki authored May 11, 2023
1 parent 4d0b0bf commit 3707f8e
Show file tree
Hide file tree
Showing 589 changed files with 116,820 additions and 3 deletions.
56 changes: 56 additions & 0 deletions docs/docs/AWSAutoScaling.md
Original file line number Diff line number Diff line change
@@ -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)


181 changes: 181 additions & 0 deletions docs/docs/AWSCloudProviderContainer.md
Original file line number Diff line number Diff line change
@@ -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)


160 changes: 160 additions & 0 deletions docs/docs/AWSClustersDNSApi.md
Original file line number Diff line number Diff line change
@@ -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)

Loading

0 comments on commit 3707f8e

Please sign in to comment.