types

Documentation

Index

• type ComplianceStatus
• type ComplianceType
• type CreateJobInput
  • func (p *CreateJobInput) Body() io.Reader
  • func (p *CreateJobInput) ContentType() string
  • func (p *CreateJobInput) ParameterMap() map[string]string
  • func (p *CreateJobInput) ResolveEndpoint(endpointBase string) string
• type CreateJobOutput
  • func (r *CreateJobOutput) HasPartialError() bool
• type GetJobInput
  • func (p *GetJobInput) Body() io.Reader
  • func (p *GetJobInput) ContentType() string
  • func (p *GetJobInput) ParameterMap() map[string]string
  • func (p *GetJobInput) ResolveEndpoint(endpointBase string) string
• type GetJobOutput
  • func (r *GetJobOutput) HasPartialError() bool
• type ListJobsInput
  • func (p *ListJobsInput) Body() io.Reader
  • func (p *ListJobsInput) ContentType() string
  • func (p *ListJobsInput) ParameterMap() map[string]string
  • func (p *ListJobsInput) ResolveEndpoint(endpointBase string) string
• type ListJobsOutput
  • func (r *ListJobsOutput) HasPartialError() bool

Types

type ComplianceStatus

type ComplianceStatus string

const (
	ComplianceStatusCreated    ComplianceStatus = "created"
	ComplianceStatusInProgress ComplianceStatus = "in_progress"
	ComplianceStatusFailed     ComplianceStatus = "failed"
	ComplianceStatusComplete   ComplianceStatus = "complete"
)

type ComplianceType

type ComplianceType string

const (
	ComplianceTypeTweets ComplianceType = "tweets"
	ComplianceTypeUsers  ComplianceType = "users"
)

type CreateJobInput

type CreateJobInput struct {
	// JSON body parameter
	Type      ComplianceType `json:"type,omitempty"` // required
	Name      *string        `json:"name,omitempty"`
	Resumable *bool          `json:"resumable,omitempty"`
}

func (*CreateJobInput) Body

func (p *CreateJobInput) Body() io.Reader

func (*CreateJobInput) ContentType

func (p *CreateJobInput) ContentType() string

func (*CreateJobInput) ParameterMap

func (p *CreateJobInput) ParameterMap() map[string]string

func (*CreateJobInput) ResolveEndpoint

func (p *CreateJobInput) ResolveEndpoint(endpointBase string) string

type CreateJobOutput

type CreateJobOutput struct {
	Data   resources.Compliance     `json:"data"`
	Errors []resources.PartialError `json:"errors"`
}

func (*CreateJobOutput) HasPartialError

func (r *CreateJobOutput) HasPartialError() bool

type GetJobInput

type GetJobInput struct {
	// Path parameters
	ID string
}

func (*GetJobInput) Body

func (p *GetJobInput) Body() io.Reader

func (*GetJobInput) ContentType

func (p *GetJobInput) ContentType() string

func (*GetJobInput) ParameterMap

func (p *GetJobInput) ParameterMap() map[string]string

func (*GetJobInput) ResolveEndpoint

func (p *GetJobInput) ResolveEndpoint(endpointBase string) string

type GetJobOutput

type GetJobOutput struct {
	Data   resources.Compliance     `json:"data"`
	Errors []resources.PartialError `json:"errors"`
}

func (*GetJobOutput) HasPartialError

func (r *GetJobOutput) HasPartialError() bool

type ListJobsInput

type ListJobsInput struct {
	// Query Parameters
	Type   ComplianceType
	Status ComplianceStatus
}

func (*ListJobsInput) Body

func (p *ListJobsInput) Body() io.Reader

func (*ListJobsInput) ContentType

func (p *ListJobsInput) ContentType() string

func (*ListJobsInput) ParameterMap

func (p *ListJobsInput) ParameterMap() map[string]string

func (*ListJobsInput) ResolveEndpoint

func (p *ListJobsInput) ResolveEndpoint(endpointBase string) string

type ListJobsOutput

type ListJobsOutput struct {
	Data   []resources.Compliance   `json:"data"`
	Errors []resources.PartialError `json:"errors"`
}

func (*ListJobsOutput) HasPartialError

func (r *ListJobsOutput) HasPartialError() bool