Skip to content

Latest commit

 

History

History
358 lines (269 loc) · 23.7 KB

README.md

File metadata and controls

358 lines (269 loc) · 23.7 KB

Compliance

(Compliance)

Overview

Access compliance data

Available Operations

GetGlobalCompliance

Get current global compliance of a Rudder server

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var precision *int64 = rudder.Int64(0)
    ctx := context.Background()
    res, err := s.Compliance.GetGlobalCompliance(ctx, precision)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
precision *int64 ➖ Number of digits after comma in compliance percent figures 0

Response

*operations.GetGlobalComplianceResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetDirectivesCompliance

Get current compliance of all the nodes of a Rudder server

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Compliance.GetDirectivesCompliance(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.

Response

*operations.GetDirectivesComplianceResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetDirectiveComplianceID

Get current compliance of a directive of a Rudder server

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var directiveID string = "9a1773c9-0889-40b6-be89-f6504443ac1b"

    var format *string = rudder.String("<value>")
    ctx := context.Background()
    res, err := s.Compliance.GetDirectiveComplianceID(ctx, directiveID, format)
    if err != nil {
        log.Fatal(err)
    }
    if res.OneOf != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
directiveID string ✔️ Id of the directive 9a1773c9-0889-40b6-be89-f6504443ac1b
format *string ➖ format of export

Response

*operations.GetDirectiveComplianceIDResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetNodesCompliance

Get current compliance of all the nodes of a Rudder server

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var level *int64 = rudder.Int64(4)

    var precision *int64 = rudder.Int64(0)
    ctx := context.Background()
    res, err := s.Compliance.GetNodesCompliance(ctx, level, precision)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
level *int64 ➖ Number of depth level of compliance objects to display (1:rules, 2:directives, 3:components, 4:nodes, 5:values, 6:reports) 4
precision *int64 ➖ Number of digits after comma in compliance percent figures 0

Response

*operations.GetNodesComplianceResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetNodeCompliance

Get current compliance of a node of a Rudder server

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var nodeID string = "9a1773c9-0889-40b6-be89-f6504443ac1b"

    var level *int64 = rudder.Int64(4)

    var precision *int64 = rudder.Int64(0)
    ctx := context.Background()
    res, err := s.Compliance.GetNodeCompliance(ctx, nodeID, level, precision)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
nodeID string ✔️ Id of the target node 9a1773c9-0889-40b6-be89-f6504443ac1b
level *int64 ➖ Number of depth level of compliance objects to display (1:rules, 2:directives, 3:components, 4:nodes, 5:values, 6:reports) 4
precision *int64 ➖ Number of digits after comma in compliance percent figures 0

Response

*operations.GetNodeComplianceResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetRulesCompliance

Get current compliance of all the rules of a Rudder server

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var level *int64 = rudder.Int64(4)

    var precision *int64 = rudder.Int64(0)
    ctx := context.Background()
    res, err := s.Compliance.GetRulesCompliance(ctx, level, precision)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
level *int64 ➖ Number of depth level of compliance objects to display (1:rules, 2:directives, 3:components, 4:nodes, 5:values, 6:reports) 4
precision *int64 ➖ Number of digits after comma in compliance percent figures 0

Response

*operations.GetRulesComplianceResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetRuleCompliance

Get current compliance of a rule of a Rudder server

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var ruleID string = "9a1773c9-0889-40b6-be89-f6504443ac1b"

    var level *int64 = rudder.Int64(4)

    var precision *int64 = rudder.Int64(0)
    ctx := context.Background()
    res, err := s.Compliance.GetRuleCompliance(ctx, ruleID, level, precision)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
ruleID string ✔️ Id of the target rule 9a1773c9-0889-40b6-be89-f6504443ac1b
level *int64 ➖ Number of depth level of compliance objects to display (1:rules, 2:directives, 3:components, 4:nodes, 5:values, 6:reports) 4
precision *int64 ➖ Number of digits after comma in compliance percent figures 0

Response

*operations.GetRuleComplianceResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /