group

Documentation

Index

• type GetWhitelistEntryOutput
• type GetWhitelistOutput
• type Group
  • func New(gid string) *Group
  • func (g *Group) DeleteWhitelistEntry(in string) error
  • func (g *Group) DeleteWhitelistEntryRequest(in string) (req *request.Request)
  • func (g *Group) GetWhitelist() (*GetWhitelistOutput, error)
  • func (g *Group) GetWhitelistEntry(in string) (*GetWhitelistEntryOutput, error)
  • func (g *Group) GetWhitelistEntryRequest(in string) (req *request.Request, out *GetWhitelistEntryOutput)
  • func (g *Group) GetWhitelistRequest() (req *request.Request, out *GetWhitelistOutput)
  • func (g *Group) SetWhitelistEntry(in *SetWhitelistEntryInput) error
  • func (g *Group) SetWhitelistEntryRequest(in *SetWhitelistEntryInput) (req *request.Request)
• type SetWhitelistEntryInput
• type WhitelistEntry

Types

type GetWhitelistEntryOutput

type GetWhitelistEntryOutput WhitelistEntry

A GetWhitelistEntryOutput is the JSON structure a GetWhitelistEntry API operation returns. https://docs.atlas.mongodb.com/reference/api/whitelist/#id2

type GetWhitelistOutput

type GetWhitelistOutput []WhitelistEntry

A GetWhitelistOutput is the JSON structure a GetWhitelist API operation returns. https://docs.atlas.mongodb.com/reference/api/whitelist/#id1

type Group

type Group struct {
	*client.Client
	GroupID string
}

Group provides the API operation methods for making requests to MongoDB Atlas in context of a Group (aka Project).

func New

func New(gid string) *Group

New creates a new instance of the Group client.

func (*Group) DeleteWhitelistEntry

func (g *Group) DeleteWhitelistEntry(in string) error

The DeleteWhitelistEntry API operation for MongoDB Atlas Group Service deletes an IP address from a group's whitelist.

The "in" value needs to be a string representation of an IP address or CIDR block. https://tools.ietf.org/html/rfc4632

func (*Group) DeleteWhitelistEntryRequest

func (g *Group) DeleteWhitelistEntryRequest(in string) (req *request.Request)

DeleteWhitelistEntryRequest generates a "common/request.Request" representing the client's request for the DeleteWhitelistEntry operation.

The "in" value needs to be a string representation of an IP address or CIDR block. https://tools.ietf.org/html/rfc4632

func (*Group) GetWhitelist

func (g *Group) GetWhitelist() (*GetWhitelistOutput, error)

The GetWhitelist API operation for MongoDB Atlas Group Service retrieves a group's IP address whitelist, which controls client access to the group's MongoDB clusters.

func (*Group) GetWhitelistEntry

func (g *Group) GetWhitelistEntry(in string) (*GetWhitelistEntryOutput, error)

The GetWhitelistEntry API operation for MongoDB Atlas Group Service retrieves an IP address from a group's whitelist.

The "in" value needs to be a string representation of an IP address or CIDR block. https://tools.ietf.org/html/rfc4632

func (*Group) GetWhitelistEntryRequest

func (g *Group) GetWhitelistEntryRequest(in string) (req *request.Request, out *GetWhitelistEntryOutput)

GetWhitelistEntryRequest generates a "common/request.Request" representing the client's request for the GetWhitelistEntry operation.

The "out" return value will be populated with the request's response once the request completes successfully.

The "in" value needs to be a string representation of an IP address or CIDR block. https://tools.ietf.org/html/rfc4632

func (*Group) GetWhitelistRequest

func (g *Group) GetWhitelistRequest() (req *request.Request, out *GetWhitelistOutput)

GetWhitelistRequest generates a "common/request.Request" representing the client's request for the GetWhitelist operation.

The "out" return value will be populated with the request's response once the request completes successfully.

func (*Group) SetWhitelistEntry

func (g *Group) SetWhitelistEntry(in *SetWhitelistEntryInput) error

The SetWhitelistEntry API operation for MongoDB Atlas Group Service adds an IP address or CIDR block to a group's whitelist.

func (*Group) SetWhitelistEntryRequest

func (g *Group) SetWhitelistEntryRequest(in *SetWhitelistEntryInput) (req *request.Request)

GetWhitelistEntryRequest generates a "common/request.Request" representing the client's request for the GetWhitelistEntry operation.

The "out" return value will be populated with the request's response once the request completes successfully.

The "in" value needs to be an array of whitelist entries.

type SetWhitelistEntryInput

type SetWhitelistEntryInput []WhitelistEntry

A SetWhitelistEntryInput is the input JSON structure for a SetWhitelistEntry API operation. https://docs.atlas.mongodb.com/reference/api/whitelist/#id5

type WhitelistEntry

type WhitelistEntry struct {
	CidrBlock       string     `json:"cidrBlock,omitempty"`
	Comment         string     `json:"comment,omitempty"`
	GroupId         string     `json:"groupId,omitempty"`
	IpAddress       string     `json:"ipAddress,omitempty"`
	DeleteAfterDate *time.Time `json:"deleteAfterDate,omitempty"`
}

A WhitelistEntry is a generic JSON structure used in API operations on group IP whitelists. https://docs.atlas.mongodb.com/reference/api/whitelist/#sample-entity