Documentation
¶
Overview ¶
Templates are automated blueprints for provisioning cloud infrastructure. They support rapid deployment with features like version control, JSON-based configurations, and customizable settings for infrastructure components.
For more details, visit our [Documentation](https://docs.stackguardian.io/docs/develop/library/overview/).
Index ¶
- type Client
- func (c *Client) CreateTemplateRevision(ctx context.Context, request *sgsdkgo.CreateTemplateRevisionRequest, ...) (*sgsdkgo.CreateTemplateResponse, error)
- func (c *Client) DeleteTemplateRevision(ctx context.Context, org string, templateRevision string, templateType string, ...) error
- func (c *Client) ListAllTemplates(ctx context.Context, templateType sgsdkgo.ListAllTemplatesRequestTemplateType, ...) (*sgsdkgo.ListallTemplatesResponse, error)
- func (c *Client) ListAllTemplatesBasedOnOwnerOrg(ctx context.Context, org string, ...) (*sgsdkgo.ListallTemplatesResponse, error)
- func (c *Client) ReadIacGroupsIacTemplate(ctx context.Context, org string, subTemplateId string, template string, ...) (*sgsdkgo.TemplateGetResponse, error)
- func (c *Client) ReadSubscription(ctx context.Context, org string, request *sgsdkgo.ReadSubscriptionRequest, ...) (*sgsdkgo.GetSubscriptionResponse, error)
- func (c *Client) ReadTemplateRevision(ctx context.Context, org string, templateRevision string, ...) (*sgsdkgo.TemplateGetResponse, error)
- func (c *Client) UpdateTemplateRevision(ctx context.Context, org string, templateRevision string, templateType string, ...) (*sgsdkgo.TemplateCreatePatchResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(opts ...option.RequestOption) *Client
func (*Client) CreateTemplateRevision ¶
func (c *Client) CreateTemplateRevision( ctx context.Context, request *sgsdkgo.CreateTemplateRevisionRequest, opts ...option.RequestOption, ) (*sgsdkgo.CreateTemplateResponse, error)
Create a new revision of a template or create the initial template if it doesn't exist.
func (*Client) DeleteTemplateRevision ¶
func (c *Client) DeleteTemplateRevision( ctx context.Context, org string, templateRevision string, templateType string, request *sgsdkgo.DeleteTemplateRevisionRequest, opts ...option.RequestOption, ) error
Delete a specific template revision. If all revisions are deleted, the parent template is also removed.
func (*Client) ListAllTemplates ¶
func (c *Client) ListAllTemplates( ctx context.Context, templateType sgsdkgo.ListAllTemplatesRequestTemplateType, request *sgsdkgo.ListAllTemplatesRequest, opts ...option.RequestOption, ) (*sgsdkgo.ListallTemplatesResponse, error)
List all Templates and it's revisions created or subscribed by the Organization. Supports Pagination and Filtering using query parameters.
func (*Client) ListAllTemplatesBasedOnOwnerOrg ¶ added in v1.2.0
func (c *Client) ListAllTemplatesBasedOnOwnerOrg( ctx context.Context, org string, request *sgsdkgo.ListAllTemplatesBasedOnOwnerOrgRequest, opts ...option.RequestOption, ) (*sgsdkgo.ListallTemplatesResponse, error)
List all Templates and it's revisions created by the Organization.
func (*Client) ReadIacGroupsIacTemplate ¶ added in v1.1.0
func (c *Client) ReadIacGroupsIacTemplate( ctx context.Context, org string, subTemplateId string, template string, request *sgsdkgo.ReadIacGroupsIacTemplateRequest, opts ...option.RequestOption, ) (*sgsdkgo.TemplateGetResponse, error)
Retrieve an IAC Group's IAC Template configuration.
func (*Client) ReadSubscription ¶
func (c *Client) ReadSubscription( ctx context.Context, org string, request *sgsdkgo.ReadSubscriptionRequest, opts ...option.RequestOption, ) (*sgsdkgo.GetSubscriptionResponse, error)
Read all the templates that are subscribed by an organization.
func (*Client) ReadTemplateRevision ¶
func (c *Client) ReadTemplateRevision( ctx context.Context, org string, templateRevision string, templateType sgsdkgo.ReadTemplateRevisionRequestTemplateType, request *sgsdkgo.ReadTemplateRevisionRequest, opts ...option.RequestOption, ) (*sgsdkgo.TemplateGetResponse, error)
Retrieve a specific template revision or the base template. Use format `template-name:revision` to fetch a specific revision (e.g., `my-template:5`). If revision is not passed (e.g., `my-template`), it will fetch the base template details.
func (*Client) UpdateTemplateRevision ¶
func (c *Client) UpdateTemplateRevision( ctx context.Context, org string, templateRevision string, templateType string, request *sgsdkgo.PatchedTemplateUpdate, opts ...option.RequestOption, ) (*sgsdkgo.TemplateCreatePatchResponse, error)
Update an existing parent template or its revision with new configuration.
Source Files