job

Documentation

Index

• Constants
• func New() resource.Resource
• type BasicAuth
• type Job
  • func (j *Job) FromClientJob(cj scrapeconfig.Job)
  • func (j *Job) ToClientJob() scrapeconfig.CreateJSONBody
  • func (j *Job) ToClientPartialUpdateJobs() scrapeconfig.PartialUpdateJSONBody
• type Resource
  • func (r *Resource) Configure(ctx context.Context, req resource.ConfigureRequest, ...)
  • func (r Resource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)
  • func (r Resource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)
  • func (r *Resource) ImportState(ctx context.Context, req resource.ImportStateRequest, ...)
  • func (r *Resource) Metadata(_ context.Context, req resource.MetadataRequest, ...)
  • func (r Resource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)
  • func (r *Resource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)
  • func (r Resource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)
• type SAML2
• type Target

Constants

const (
	DefaultMetricsPath              = "/metrics"
	DefaultScheme                   = "https"
	DefaultScrapeInterval           = "5m"
	DefaultScrapeTimeout            = "2m"
	DefaultSampleLimit              = 5000
	DefaultSAML2EnableURLParameters = true
)

Functions

func New

func New() resource.Resource

New returns a new configured resource

Types

type BasicAuth

type BasicAuth struct {
	Username types.String `tfsdk:"username"`
	Password types.String `tfsdk:"password"`
}

BasicAuth holds basic auth data

type Job

type Job struct {
	ID              types.String `tfsdk:"id"`
	Name            types.String `tfsdk:"name"`
	ProjectID       types.String `tfsdk:"project_id"`
	ArgusInstanceID types.String `tfsdk:"argus_instance_id"`
	MetricsPath     types.String `tfsdk:"metrics_path"`
	Scheme          types.String `tfsdk:"scheme"`
	ScrapeInterval  types.String `tfsdk:"scrape_interval"`
	ScrapeTimeout   types.String `tfsdk:"scrape_timeout"`
	SampleLimit     types.Int64  `tfsdk:"sample_limit"`
	SAML2           *SAML2       `tfsdk:"saml2"`
	BasicAuth       *BasicAuth   `tfsdk:"basic_auth"`
	Targets         []Target     `tfsdk:"targets"`
}

Job is the schema model

func (*Job) FromClientJob

func (j *Job) FromClientJob(cj scrapeconfig.Job)

func (*Job) ToClientJob

func (j *Job) ToClientJob() scrapeconfig.CreateJSONBody

func (*Job) ToClientPartialUpdateJobs

func (j *Job) ToClientPartialUpdateJobs() scrapeconfig.PartialUpdateJSONBody

type Resource

type Resource struct {
	// contains filtered or unexported fields
}

Resource is the exported resource

func (*Resource) Configure

func (r *Resource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure the resource client

func (Resource) Create

func (r Resource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create - lifecycle function

func (Resource) Delete

func (r Resource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete - lifecycle function

func (*Resource) ImportState

func (r *Resource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState handles terraform import

func (*Resource) Metadata

func (r *Resource) Metadata(_ context.Context, req resource.MetadataRequest, res *resource.MetadataResponse)

Metadata returns data resource metadata

func (Resource) Read

func (r Resource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read - lifecycle function

func (*Resource) Schema

func (r *Resource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)

Schema returns the terraform schema structure

func (Resource) Update

func (r Resource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update - lifecycle function

type SAML2

type SAML2 struct {
	EnableURLParameters types.Bool `tfsdk:"enable_url_parameters"`
}

SAML2 holds saml configuration

type Target

type Target struct {
	URLs   []types.String `tfsdk:"urls"`
	Labels types.Map      `tfsdk:"labels"`
}

Target holds targets for scraping