Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 3.86 KB

RollingIndexApi.md

File metadata and controls

86 lines (55 loc) · 3.86 KB
Raw

\RollingIndexApi

All URIs are relative to https://cloud.mongodb.com

Method HTTP request Description
CreateOneRollingIndex Post /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/index Create One Rolling Index

CreateOneRollingIndex

CreateOneRollingIndex(ctx, groupId, clusterName).ApiIndexRequestView(apiIndexRequestView).Envelope(envelope).Pretty(pretty).Execute()

Create One Rolling Index

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "32b6e34b3d91647abb20e7b8" // string | Unique 24-hexadecimal digit string that identifies your project.
    clusterName := "clusterName_example" // string | Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.
    apiIndexRequestView := *openapiclient.NewApiIndexRequestView("Collection_example", "Db_example", []map[string]string{map[string]string{"key": "Inner_example"}}) // ApiIndexRequestView | Rolling index to create on the specified cluster.
    envelope := false // bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. (optional) (default to false)
    pretty := false // bool | Flag that indicates whether the response body should be in the prettyprint format. (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RollingIndexApi.CreateOneRollingIndex(context.Background(), groupId, clusterName).ApiIndexRequestView(apiIndexRequestView).Envelope(envelope).Pretty(pretty).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RollingIndexApi.CreateOneRollingIndex``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

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.
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 apiCreateOneRollingIndexRequest struct via the builder pattern

Name Type Description Notes

apiIndexRequestView | ApiIndexRequestView | Rolling index to create on the specified cluster. | envelope | bool | Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. | [default to false] pretty | bool | Flag that indicates whether the response body should be in the prettyprint format. | [default to false]

Return type

(empty response body)

Authorization

DigestAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]