workflows

package
v4.0.0-...-bae6edb Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type InstanceGetParams 

type InstanceGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type InstanceGetResponse 

type InstanceGetResponse struct {
	End       time.Time                      `json:"end,required,nullable" format:"date-time"`
	Error     InstanceGetResponseError       `json:"error,required,nullable"`
	Output    InstanceGetResponseOutputUnion `json:"output,required"`
	Params    interface{}                    `json:"params,required"`
	Queued    time.Time                      `json:"queued,required" format:"date-time"`
	Start     time.Time                      `json:"start,required,nullable" format:"date-time"`
	Status    InstanceGetResponseStatus      `json:"status,required"`
	Steps     []InstanceGetResponseStep      `json:"steps,required"`
	Success   bool                           `json:"success,required,nullable"`
	Trigger   InstanceGetResponseTrigger     `json:"trigger,required"`
	VersionID string                         `json:"versionId,required" format:"uuid"`
	JSON      instanceGetResponseJSON        `json:"-"`
}

func (*InstanceGetResponse) UnmarshalJSON 

func (r *InstanceGetResponse) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseEnvelope 

type InstanceGetResponseEnvelope struct {
	Errors     []InstanceGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []InstanceGetResponseEnvelopeMessages `json:"messages,required"`
	Result     InstanceGetResponse                   `json:"result,required"`
	Success    InstanceGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo InstanceGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       instanceGetResponseEnvelopeJSON       `json:"-"`
}

func (*InstanceGetResponseEnvelope) UnmarshalJSON 

func (r *InstanceGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseEnvelopeErrors 

type InstanceGetResponseEnvelopeErrors struct {
	Code    float64                               `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    instanceGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*InstanceGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *InstanceGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseEnvelopeMessages 

type InstanceGetResponseEnvelopeMessages struct {
	Code    float64                                 `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    instanceGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*InstanceGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *InstanceGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseEnvelopeResultInfo 

type InstanceGetResponseEnvelopeResultInfo struct {
	Count      float64                                   `json:"count,required"`
	Page       float64                                   `json:"page,required"`
	PerPage    float64                                   `json:"per_page,required"`
	TotalCount float64                                   `json:"total_count,required"`
	JSON       instanceGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*InstanceGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *InstanceGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseEnvelopeSuccess 

type InstanceGetResponseEnvelopeSuccess bool
const (
	InstanceGetResponseEnvelopeSuccessTrue InstanceGetResponseEnvelopeSuccess = true
)

func (InstanceGetResponseEnvelopeSuccess) IsKnown 

func (r InstanceGetResponseEnvelopeSuccess) IsKnown() bool

type InstanceGetResponseError 

type InstanceGetResponseError struct {
	Message string                       `json:"message,required"`
	Name    string                       `json:"name,required"`
	JSON    instanceGetResponseErrorJSON `json:"-"`
}

func (*InstanceGetResponseError) UnmarshalJSON 

func (r *InstanceGetResponseError) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseOutputUnion 

type InstanceGetResponseOutputUnion interface {
	ImplementsWorkflowsInstanceGetResponseOutputUnion()
}

Union satisfied by shared.UnionString or shared.UnionFloat.

type InstanceGetResponseStatus 

type InstanceGetResponseStatus string
const (
	InstanceGetResponseStatusQueued          InstanceGetResponseStatus = "queued"
	InstanceGetResponseStatusRunning         InstanceGetResponseStatus = "running"
	InstanceGetResponseStatusPaused          InstanceGetResponseStatus = "paused"
	InstanceGetResponseStatusErrored         InstanceGetResponseStatus = "errored"
	InstanceGetResponseStatusTerminated      InstanceGetResponseStatus = "terminated"
	InstanceGetResponseStatusComplete        InstanceGetResponseStatus = "complete"
	InstanceGetResponseStatusWaitingForPause InstanceGetResponseStatus = "waitingForPause"
	InstanceGetResponseStatusWaiting         InstanceGetResponseStatus = "waiting"
	InstanceGetResponseStatusUnknown         InstanceGetResponseStatus = "unknown"
)

func (InstanceGetResponseStatus) IsKnown 

func (r InstanceGetResponseStatus) IsKnown() bool

type InstanceGetResponseStep 

type InstanceGetResponseStep struct {
	Type InstanceGetResponseStepsType `json:"type,required"`
	// This field can have the runtime type of
	// [[]InstanceGetResponseStepsObjectAttempt].
	Attempts interface{} `json:"attempts"`
	// This field can have the runtime type of [InstanceGetResponseStepsObjectConfig].
	Config interface{} `json:"config"`
	End    time.Time   `json:"end,nullable" format:"date-time"`
	// This field can have the runtime type of [InstanceGetResponseStepsObjectError].
	Error    interface{} `json:"error"`
	Finished bool        `json:"finished"`
	Name     string      `json:"name"`
	// This field can have the runtime type of [interface{}].
	Output  interface{} `json:"output"`
	Start   time.Time   `json:"start" format:"date-time"`
	Success bool        `json:"success,nullable"`
	// This field can have the runtime type of [InstanceGetResponseStepsObjectTrigger].
	Trigger interface{}                 `json:"trigger"`
	JSON    instanceGetResponseStepJSON `json:"-"`
	// contains filtered or unexported fields
}

func (InstanceGetResponseStep) AsUnion 

func (r InstanceGetResponseStep) AsUnion() InstanceGetResponseStepsUnion

AsUnion returns a InstanceGetResponseStepsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are workflows.InstanceGetResponseStepsObject, workflows.InstanceGetResponseStepsObject, workflows.InstanceGetResponseStepsObject.

func (*InstanceGetResponseStep) UnmarshalJSON 

func (r *InstanceGetResponseStep) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseStepsObject 

type InstanceGetResponseStepsObject struct {
	Attempts []InstanceGetResponseStepsObjectAttempt `json:"attempts,required"`
	Config   InstanceGetResponseStepsObjectConfig    `json:"config,required"`
	End      time.Time                               `json:"end,required,nullable" format:"date-time"`
	Name     string                                  `json:"name,required"`
	Output   interface{}                             `json:"output,required"`
	Start    time.Time                               `json:"start,required" format:"date-time"`
	Success  bool                                    `json:"success,required,nullable"`
	Type     InstanceGetResponseStepsObjectType      `json:"type,required"`
	JSON     instanceGetResponseStepsObjectJSON      `json:"-"`
}

func (*InstanceGetResponseStepsObject) UnmarshalJSON 

func (r *InstanceGetResponseStepsObject) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseStepsObjectAttempt 

type InstanceGetResponseStepsObjectAttempt struct {
	End     time.Time                                   `json:"end,required,nullable" format:"date-time"`
	Error   InstanceGetResponseStepsObjectAttemptsError `json:"error,required,nullable"`
	Start   time.Time                                   `json:"start,required" format:"date-time"`
	Success bool                                        `json:"success,required,nullable"`
	JSON    instanceGetResponseStepsObjectAttemptJSON   `json:"-"`
}

func (*InstanceGetResponseStepsObjectAttempt) UnmarshalJSON 

func (r *InstanceGetResponseStepsObjectAttempt) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseStepsObjectAttemptsError 

type InstanceGetResponseStepsObjectAttemptsError struct {
	Message string                                          `json:"message,required"`
	Name    string                                          `json:"name,required"`
	JSON    instanceGetResponseStepsObjectAttemptsErrorJSON `json:"-"`
}

func (*InstanceGetResponseStepsObjectAttemptsError) UnmarshalJSON 

func (r *InstanceGetResponseStepsObjectAttemptsError) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseStepsObjectConfig 

type InstanceGetResponseStepsObjectConfig struct {
	Retries InstanceGetResponseStepsObjectConfigRetries      `json:"retries,required"`
	Timeout InstanceGetResponseStepsObjectConfigTimeoutUnion `json:"timeout,required"`
	JSON    instanceGetResponseStepsObjectConfigJSON         `json:"-"`
}

func (*InstanceGetResponseStepsObjectConfig) UnmarshalJSON 

func (r *InstanceGetResponseStepsObjectConfig) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseStepsObjectConfigRetries 

type InstanceGetResponseStepsObjectConfigRetries struct {
	Delay   InstanceGetResponseStepsObjectConfigRetriesDelayUnion `json:"delay,required"`
	Limit   float64                                               `json:"limit,required"`
	Backoff InstanceGetResponseStepsObjectConfigRetriesBackoff    `json:"backoff"`
	JSON    instanceGetResponseStepsObjectConfigRetriesJSON       `json:"-"`
}

func (*InstanceGetResponseStepsObjectConfigRetries) UnmarshalJSON 

func (r *InstanceGetResponseStepsObjectConfigRetries) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseStepsObjectConfigRetriesBackoff 

type InstanceGetResponseStepsObjectConfigRetriesBackoff string
const (
	InstanceGetResponseStepsObjectConfigRetriesBackoffConstant    InstanceGetResponseStepsObjectConfigRetriesBackoff = "constant"
	InstanceGetResponseStepsObjectConfigRetriesBackoffLinear      InstanceGetResponseStepsObjectConfigRetriesBackoff = "linear"
	InstanceGetResponseStepsObjectConfigRetriesBackoffExponential InstanceGetResponseStepsObjectConfigRetriesBackoff = "exponential"
)

func (InstanceGetResponseStepsObjectConfigRetriesBackoff) IsKnown 

func (r InstanceGetResponseStepsObjectConfigRetriesBackoff) IsKnown() bool

type InstanceGetResponseStepsObjectConfigRetriesDelayUnion 

type InstanceGetResponseStepsObjectConfigRetriesDelayUnion interface {
	ImplementsWorkflowsInstanceGetResponseStepsObjectConfigRetriesDelayUnion()
}

Union satisfied by shared.UnionString or shared.UnionFloat.

type InstanceGetResponseStepsObjectConfigTimeoutUnion 

type InstanceGetResponseStepsObjectConfigTimeoutUnion interface {
	ImplementsWorkflowsInstanceGetResponseStepsObjectConfigTimeoutUnion()
}

Union satisfied by shared.UnionString or shared.UnionFloat.

type InstanceGetResponseStepsObjectType 

type InstanceGetResponseStepsObjectType string
const (
	InstanceGetResponseStepsObjectTypeStep InstanceGetResponseStepsObjectType = "step"
)

func (InstanceGetResponseStepsObjectType) IsKnown 

func (r InstanceGetResponseStepsObjectType) IsKnown() bool

type InstanceGetResponseStepsType 

type InstanceGetResponseStepsType string
const (
	InstanceGetResponseStepsTypeStep        InstanceGetResponseStepsType = "step"
	InstanceGetResponseStepsTypeSleep       InstanceGetResponseStepsType = "sleep"
	InstanceGetResponseStepsTypeTermination InstanceGetResponseStepsType = "termination"
)

func (InstanceGetResponseStepsType) IsKnown 

func (r InstanceGetResponseStepsType) IsKnown() bool

type InstanceGetResponseStepsUnion 

type InstanceGetResponseStepsUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by workflows.InstanceGetResponseStepsObject, workflows.InstanceGetResponseStepsObject or workflows.InstanceGetResponseStepsObject.

type InstanceGetResponseTrigger 

type InstanceGetResponseTrigger struct {
	Source InstanceGetResponseTriggerSource `json:"source,required"`
	JSON   instanceGetResponseTriggerJSON   `json:"-"`
}

func (*InstanceGetResponseTrigger) UnmarshalJSON 

func (r *InstanceGetResponseTrigger) UnmarshalJSON(data []byte) (err error)

type InstanceGetResponseTriggerSource 

type InstanceGetResponseTriggerSource string
const (
	InstanceGetResponseTriggerSourceUnknown InstanceGetResponseTriggerSource = "unknown"
	InstanceGetResponseTriggerSourceAPI     InstanceGetResponseTriggerSource = "api"
	InstanceGetResponseTriggerSourceBinding InstanceGetResponseTriggerSource = "binding"
	InstanceGetResponseTriggerSourceEvent   InstanceGetResponseTriggerSource = "event"
	InstanceGetResponseTriggerSourceCron    InstanceGetResponseTriggerSource = "cron"
)

func (InstanceGetResponseTriggerSource) IsKnown 

func (r InstanceGetResponseTriggerSource) IsKnown() bool

type InstanceListParams 

type InstanceListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// In ISO 8601 with no timezone offsets and in UTC.
	DateEnd param.Field[time.Time] `query:"date_end" format:"date-time"`
	// In ISO 8601 with no timezone offsets and in UTC.
	DateStart param.Field[time.Time]                `query:"date_start" format:"date-time"`
	Page      param.Field[float64]                  `query:"page"`
	PerPage   param.Field[float64]                  `query:"per_page"`
	Status    param.Field[InstanceListParamsStatus] `query:"status"`
}

func (InstanceListParams) URLQuery 

func (r InstanceListParams) URLQuery() (v url.Values)

URLQuery serializes InstanceListParams's query parameters as `url.Values`.

type InstanceListParamsStatus 

type InstanceListParamsStatus string
const (
	InstanceListParamsStatusQueued          InstanceListParamsStatus = "queued"
	InstanceListParamsStatusRunning         InstanceListParamsStatus = "running"
	InstanceListParamsStatusPaused          InstanceListParamsStatus = "paused"
	InstanceListParamsStatusErrored         InstanceListParamsStatus = "errored"
	InstanceListParamsStatusTerminated      InstanceListParamsStatus = "terminated"
	InstanceListParamsStatusComplete        InstanceListParamsStatus = "complete"
	InstanceListParamsStatusWaitingForPause InstanceListParamsStatus = "waitingForPause"
	InstanceListParamsStatusWaiting         InstanceListParamsStatus = "waiting"
	InstanceListParamsStatusUnknown         InstanceListParamsStatus = "unknown"
)

func (InstanceListParamsStatus) IsKnown 

func (r InstanceListParamsStatus) IsKnown() bool

type InstanceListResponse 

type InstanceListResponse struct {
	ID         string                     `json:"id,required"`
	CreatedOn  time.Time                  `json:"created_on,required" format:"date-time"`
	EndedOn    time.Time                  `json:"ended_on,required,nullable" format:"date-time"`
	ModifiedOn time.Time                  `json:"modified_on,required" format:"date-time"`
	StartedOn  time.Time                  `json:"started_on,required,nullable" format:"date-time"`
	Status     InstanceListResponseStatus `json:"status,required"`
	VersionID  string                     `json:"version_id,required" format:"uuid"`
	WorkflowID string                     `json:"workflow_id,required" format:"uuid"`
	JSON       instanceListResponseJSON   `json:"-"`
}

func (*InstanceListResponse) UnmarshalJSON 

func (r *InstanceListResponse) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseStatus 

type InstanceListResponseStatus string
const (
	InstanceListResponseStatusQueued          InstanceListResponseStatus = "queued"
	InstanceListResponseStatusRunning         InstanceListResponseStatus = "running"
	InstanceListResponseStatusPaused          InstanceListResponseStatus = "paused"
	InstanceListResponseStatusErrored         InstanceListResponseStatus = "errored"
	InstanceListResponseStatusTerminated      InstanceListResponseStatus = "terminated"
	InstanceListResponseStatusComplete        InstanceListResponseStatus = "complete"
	InstanceListResponseStatusWaitingForPause InstanceListResponseStatus = "waitingForPause"
	InstanceListResponseStatusWaiting         InstanceListResponseStatus = "waiting"
	InstanceListResponseStatusUnknown         InstanceListResponseStatus = "unknown"
)

func (InstanceListResponseStatus) IsKnown 

func (r InstanceListResponseStatus) IsKnown() bool

type InstanceNewParams 

type InstanceNewParams struct {
	AccountID  param.Field[string]      `path:"account_id,required"`
	InstanceID param.Field[string]      `json:"instance_id"`
	Params     param.Field[interface{}] `json:"params"`
}

func (InstanceNewParams) MarshalJSON 

func (r InstanceNewParams) MarshalJSON() (data []byte, err error)

type InstanceNewResponse 

type InstanceNewResponse struct {
	ID         string                    `json:"id,required"`
	Status     InstanceNewResponseStatus `json:"status,required"`
	VersionID  string                    `json:"version_id,required" format:"uuid"`
	WorkflowID string                    `json:"workflow_id,required" format:"uuid"`
	JSON       instanceNewResponseJSON   `json:"-"`
}

func (*InstanceNewResponse) UnmarshalJSON 

func (r *InstanceNewResponse) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseEnvelope 

type InstanceNewResponseEnvelope struct {
	Errors     []InstanceNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []InstanceNewResponseEnvelopeMessages `json:"messages,required"`
	Result     InstanceNewResponse                   `json:"result,required"`
	Success    InstanceNewResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo InstanceNewResponseEnvelopeResultInfo `json:"result_info"`
	JSON       instanceNewResponseEnvelopeJSON       `json:"-"`
}

func (*InstanceNewResponseEnvelope) UnmarshalJSON 

func (r *InstanceNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseEnvelopeErrors 

type InstanceNewResponseEnvelopeErrors struct {
	Code    float64                               `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    instanceNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*InstanceNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *InstanceNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseEnvelopeMessages 

type InstanceNewResponseEnvelopeMessages struct {
	Code    float64                                 `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    instanceNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*InstanceNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *InstanceNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseEnvelopeResultInfo 

type InstanceNewResponseEnvelopeResultInfo struct {
	Count      float64                                   `json:"count,required"`
	Page       float64                                   `json:"page,required"`
	PerPage    float64                                   `json:"per_page,required"`
	TotalCount float64                                   `json:"total_count,required"`
	JSON       instanceNewResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*InstanceNewResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *InstanceNewResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseEnvelopeSuccess 

type InstanceNewResponseEnvelopeSuccess bool
const (
	InstanceNewResponseEnvelopeSuccessTrue InstanceNewResponseEnvelopeSuccess = true
)

func (InstanceNewResponseEnvelopeSuccess) IsKnown 

func (r InstanceNewResponseEnvelopeSuccess) IsKnown() bool

type InstanceNewResponseStatus 

type InstanceNewResponseStatus string
const (
	InstanceNewResponseStatusQueued          InstanceNewResponseStatus = "queued"
	InstanceNewResponseStatusRunning         InstanceNewResponseStatus = "running"
	InstanceNewResponseStatusPaused          InstanceNewResponseStatus = "paused"
	InstanceNewResponseStatusErrored         InstanceNewResponseStatus = "errored"
	InstanceNewResponseStatusTerminated      InstanceNewResponseStatus = "terminated"
	InstanceNewResponseStatusComplete        InstanceNewResponseStatus = "complete"
	InstanceNewResponseStatusWaitingForPause InstanceNewResponseStatus = "waitingForPause"
	InstanceNewResponseStatusWaiting         InstanceNewResponseStatus = "waiting"
	InstanceNewResponseStatusUnknown         InstanceNewResponseStatus = "unknown"
)

func (InstanceNewResponseStatus) IsKnown 

func (r InstanceNewResponseStatus) IsKnown() bool

type InstanceService 

type InstanceService struct {
	Options []option.RequestOption
	Status  *InstanceStatusService
}

InstanceService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInstanceService method instead.

func NewInstanceService 

func NewInstanceService(opts ...option.RequestOption) (r *InstanceService)

NewInstanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InstanceService) Get 

func (r *InstanceService) Get(ctx context.Context, workflowName string, instanceID string, query InstanceGetParams, opts ...option.RequestOption) (res *InstanceGetResponse, err error)

Get logs and status from instance

func (*InstanceService) List 

func (r *InstanceService) List(ctx context.Context, workflowName string, params InstanceListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[InstanceListResponse], err error)

List of workflow instances

func (*InstanceService) ListAutoPaging 

func (r *InstanceService) ListAutoPaging(ctx context.Context, workflowName string, params InstanceListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[InstanceListResponse]

List of workflow instances

func (*InstanceService) New 

func (r *InstanceService) New(ctx context.Context, workflowName string, params InstanceNewParams, opts ...option.RequestOption) (res *InstanceNewResponse, err error)

Create a new workflow instance

type InstanceStatusEditParams 

type InstanceStatusEditParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Possible actions to apply to instance
	Status param.Field[InstanceStatusEditParamsStatus] `json:"status,required"`
}

func (InstanceStatusEditParams) MarshalJSON 

func (r InstanceStatusEditParams) MarshalJSON() (data []byte, err error)

type InstanceStatusEditParamsStatus 

type InstanceStatusEditParamsStatus string

Possible actions to apply to instance 

const (
	InstanceStatusEditParamsStatusResume    InstanceStatusEditParamsStatus = "resume"
	InstanceStatusEditParamsStatusPause     InstanceStatusEditParamsStatus = "pause"
	InstanceStatusEditParamsStatusTerminate InstanceStatusEditParamsStatus = "terminate"
)

func (InstanceStatusEditParamsStatus) IsKnown 

func (r InstanceStatusEditParamsStatus) IsKnown() bool

type InstanceStatusEditResponse 

type InstanceStatusEditResponse struct {
	Status InstanceStatusEditResponseStatus `json:"status,required"`
	// In ISO 8601 with no timezone offsets and in UTC.
	Timestamp time.Time                      `json:"timestamp,required" format:"date-time"`
	JSON      instanceStatusEditResponseJSON `json:"-"`
}

func (*InstanceStatusEditResponse) UnmarshalJSON 

func (r *InstanceStatusEditResponse) UnmarshalJSON(data []byte) (err error)

type InstanceStatusEditResponseEnvelope 

type InstanceStatusEditResponseEnvelope struct {
	Errors     []InstanceStatusEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []InstanceStatusEditResponseEnvelopeMessages `json:"messages,required"`
	Result     InstanceStatusEditResponse                   `json:"result,required"`
	Success    InstanceStatusEditResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo InstanceStatusEditResponseEnvelopeResultInfo `json:"result_info"`
	JSON       instanceStatusEditResponseEnvelopeJSON       `json:"-"`
}

func (*InstanceStatusEditResponseEnvelope) UnmarshalJSON 

func (r *InstanceStatusEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceStatusEditResponseEnvelopeErrors 

type InstanceStatusEditResponseEnvelopeErrors struct {
	Code    float64                                      `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    instanceStatusEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*InstanceStatusEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *InstanceStatusEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InstanceStatusEditResponseEnvelopeMessages 

type InstanceStatusEditResponseEnvelopeMessages struct {
	Code    float64                                        `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    instanceStatusEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*InstanceStatusEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *InstanceStatusEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InstanceStatusEditResponseEnvelopeResultInfo 

type InstanceStatusEditResponseEnvelopeResultInfo struct {
	Count      float64                                          `json:"count,required"`
	Page       float64                                          `json:"page,required"`
	PerPage    float64                                          `json:"per_page,required"`
	TotalCount float64                                          `json:"total_count,required"`
	JSON       instanceStatusEditResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*InstanceStatusEditResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *InstanceStatusEditResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type InstanceStatusEditResponseEnvelopeSuccess 

type InstanceStatusEditResponseEnvelopeSuccess bool
const (
	InstanceStatusEditResponseEnvelopeSuccessTrue InstanceStatusEditResponseEnvelopeSuccess = true
)

func (InstanceStatusEditResponseEnvelopeSuccess) IsKnown 

func (r InstanceStatusEditResponseEnvelopeSuccess) IsKnown() bool

type InstanceStatusEditResponseStatus 

type InstanceStatusEditResponseStatus string
const (
	InstanceStatusEditResponseStatusQueued          InstanceStatusEditResponseStatus = "queued"
	InstanceStatusEditResponseStatusRunning         InstanceStatusEditResponseStatus = "running"
	InstanceStatusEditResponseStatusPaused          InstanceStatusEditResponseStatus = "paused"
	InstanceStatusEditResponseStatusErrored         InstanceStatusEditResponseStatus = "errored"
	InstanceStatusEditResponseStatusTerminated      InstanceStatusEditResponseStatus = "terminated"
	InstanceStatusEditResponseStatusComplete        InstanceStatusEditResponseStatus = "complete"
	InstanceStatusEditResponseStatusWaitingForPause InstanceStatusEditResponseStatus = "waitingForPause"
	InstanceStatusEditResponseStatusWaiting         InstanceStatusEditResponseStatus = "waiting"
	InstanceStatusEditResponseStatusUnknown         InstanceStatusEditResponseStatus = "unknown"
)

func (InstanceStatusEditResponseStatus) IsKnown 

func (r InstanceStatusEditResponseStatus) IsKnown() bool

type InstanceStatusService 

type InstanceStatusService struct {
	Options []option.RequestOption
}

InstanceStatusService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInstanceStatusService method instead.

func NewInstanceStatusService 

func NewInstanceStatusService(opts ...option.RequestOption) (r *InstanceStatusService)

NewInstanceStatusService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InstanceStatusService) Edit 

func (r *InstanceStatusService) Edit(ctx context.Context, workflowName string, instanceID string, params InstanceStatusEditParams, opts ...option.RequestOption) (res *InstanceStatusEditResponse, err error)

Change status of instance

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

type VersionGetParams 

type VersionGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type VersionGetResponse 

type VersionGetResponse struct {
	ID         string                 `json:"id,required" format:"uuid"`
	ClassName  string                 `json:"class_name,required"`
	CreatedOn  time.Time              `json:"created_on,required" format:"date-time"`
	ModifiedOn time.Time              `json:"modified_on,required" format:"date-time"`
	WorkflowID string                 `json:"workflow_id,required" format:"uuid"`
	JSON       versionGetResponseJSON `json:"-"`
}

func (*VersionGetResponse) UnmarshalJSON 

func (r *VersionGetResponse) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelope 

type VersionGetResponseEnvelope struct {
	Errors     []VersionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []VersionGetResponseEnvelopeMessages `json:"messages,required"`
	Result     VersionGetResponse                   `json:"result,required"`
	Success    VersionGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo VersionGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       versionGetResponseEnvelopeJSON       `json:"-"`
}

func (*VersionGetResponseEnvelope) UnmarshalJSON 

func (r *VersionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeErrors 

type VersionGetResponseEnvelopeErrors struct {
	Code    float64                              `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    versionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*VersionGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *VersionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeMessages 

type VersionGetResponseEnvelopeMessages struct {
	Code    float64                                `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    versionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*VersionGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *VersionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeResultInfo 

type VersionGetResponseEnvelopeResultInfo struct {
	Count      float64                                  `json:"count,required"`
	Page       float64                                  `json:"page,required"`
	PerPage    float64                                  `json:"per_page,required"`
	TotalCount float64                                  `json:"total_count,required"`
	JSON       versionGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*VersionGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *VersionGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeSuccess 

type VersionGetResponseEnvelopeSuccess bool
const (
	VersionGetResponseEnvelopeSuccessTrue VersionGetResponseEnvelopeSuccess = true
)

func (VersionGetResponseEnvelopeSuccess) IsKnown 

func (r VersionGetResponseEnvelopeSuccess) IsKnown() bool

type VersionListParams 

type VersionListParams struct {
	AccountID param.Field[string]  `path:"account_id,required"`
	Page      param.Field[float64] `query:"page"`
	PerPage   param.Field[float64] `query:"per_page"`
}

func (VersionListParams) URLQuery 

func (r VersionListParams) URLQuery() (v url.Values)

URLQuery serializes VersionListParams's query parameters as `url.Values`.

type VersionListResponse 

type VersionListResponse struct {
	ID         string                  `json:"id,required" format:"uuid"`
	ClassName  string                  `json:"class_name,required"`
	CreatedOn  time.Time               `json:"created_on,required" format:"date-time"`
	ModifiedOn time.Time               `json:"modified_on,required" format:"date-time"`
	WorkflowID string                  `json:"workflow_id,required" format:"uuid"`
	JSON       versionListResponseJSON `json:"-"`
}

func (*VersionListResponse) UnmarshalJSON 

func (r *VersionListResponse) UnmarshalJSON(data []byte) (err error)

type VersionService 

type VersionService struct {
	Options []option.RequestOption
}

VersionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewVersionService method instead.

func NewVersionService 

func NewVersionService(opts ...option.RequestOption) (r *VersionService)

NewVersionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*VersionService) Get 

func (r *VersionService) Get(ctx context.Context, workflowName string, versionID string, query VersionGetParams, opts ...option.RequestOption) (res *VersionGetResponse, err error)

Get Workflow version details

func (*VersionService) List 

func (r *VersionService) List(ctx context.Context, workflowName string, params VersionListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[VersionListResponse], err error)

List deployed Workflow versions

func (*VersionService) ListAutoPaging 

func (r *VersionService) ListAutoPaging(ctx context.Context, workflowName string, params VersionListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[VersionListResponse]

List deployed Workflow versions

type WorkflowGetParams 

type WorkflowGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type WorkflowGetResponse 

type WorkflowGetResponse struct {
	ID          string                       `json:"id,required" format:"uuid"`
	ClassName   string                       `json:"class_name,required"`
	CreatedOn   time.Time                    `json:"created_on,required" format:"date-time"`
	Instances   WorkflowGetResponseInstances `json:"instances,required"`
	ModifiedOn  time.Time                    `json:"modified_on,required" format:"date-time"`
	Name        string                       `json:"name,required"`
	ScriptName  string                       `json:"script_name,required"`
	TriggeredOn time.Time                    `json:"triggered_on,required,nullable" format:"date-time"`
	JSON        workflowGetResponseJSON      `json:"-"`
}

func (*WorkflowGetResponse) UnmarshalJSON 

func (r *WorkflowGetResponse) UnmarshalJSON(data []byte) (err error)

type WorkflowGetResponseEnvelope 

type WorkflowGetResponseEnvelope struct {
	Errors     []WorkflowGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []WorkflowGetResponseEnvelopeMessages `json:"messages,required"`
	Result     WorkflowGetResponse                   `json:"result,required"`
	Success    WorkflowGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo WorkflowGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       workflowGetResponseEnvelopeJSON       `json:"-"`
}

func (*WorkflowGetResponseEnvelope) UnmarshalJSON 

func (r *WorkflowGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type WorkflowGetResponseEnvelopeErrors 

type WorkflowGetResponseEnvelopeErrors struct {
	Code    float64                               `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    workflowGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*WorkflowGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *WorkflowGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type WorkflowGetResponseEnvelopeMessages 

type WorkflowGetResponseEnvelopeMessages struct {
	Code    float64                                 `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    workflowGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*WorkflowGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *WorkflowGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type WorkflowGetResponseEnvelopeResultInfo 

type WorkflowGetResponseEnvelopeResultInfo struct {
	Count      float64                                   `json:"count,required"`
	Page       float64                                   `json:"page,required"`
	PerPage    float64                                   `json:"per_page,required"`
	TotalCount float64                                   `json:"total_count,required"`
	JSON       workflowGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*WorkflowGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *WorkflowGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type WorkflowGetResponseEnvelopeSuccess 

type WorkflowGetResponseEnvelopeSuccess bool
const (
	WorkflowGetResponseEnvelopeSuccessTrue WorkflowGetResponseEnvelopeSuccess = true
)

func (WorkflowGetResponseEnvelopeSuccess) IsKnown 

func (r WorkflowGetResponseEnvelopeSuccess) IsKnown() bool

type WorkflowGetResponseInstances 

type WorkflowGetResponseInstances struct {
	Complete        float64                          `json:"complete"`
	Errored         float64                          `json:"errored"`
	Paused          float64                          `json:"paused"`
	Queued          float64                          `json:"queued"`
	Running         float64                          `json:"running"`
	Terminated      float64                          `json:"terminated"`
	Unknown         float64                          `json:"unknown"`
	Waiting         float64                          `json:"waiting"`
	WaitingForPause float64                          `json:"waitingForPause"`
	JSON            workflowGetResponseInstancesJSON `json:"-"`
}

func (*WorkflowGetResponseInstances) UnmarshalJSON 

func (r *WorkflowGetResponseInstances) UnmarshalJSON(data []byte) (err error)

type WorkflowListParams 

type WorkflowListParams struct {
	AccountID param.Field[string]  `path:"account_id,required"`
	Page      param.Field[float64] `query:"page"`
	PerPage   param.Field[float64] `query:"per_page"`
}

func (WorkflowListParams) URLQuery 

func (r WorkflowListParams) URLQuery() (v url.Values)

URLQuery serializes WorkflowListParams's query parameters as `url.Values`.

type WorkflowListResponse 

type WorkflowListResponse struct {
	ID          string                        `json:"id,required" format:"uuid"`
	ClassName   string                        `json:"class_name,required"`
	CreatedOn   time.Time                     `json:"created_on,required" format:"date-time"`
	Instances   WorkflowListResponseInstances `json:"instances,required"`
	ModifiedOn  time.Time                     `json:"modified_on,required" format:"date-time"`
	Name        string                        `json:"name,required"`
	ScriptName  string                        `json:"script_name,required"`
	TriggeredOn time.Time                     `json:"triggered_on,required,nullable" format:"date-time"`
	JSON        workflowListResponseJSON      `json:"-"`
}

func (*WorkflowListResponse) UnmarshalJSON 

func (r *WorkflowListResponse) UnmarshalJSON(data []byte) (err error)

type WorkflowListResponseInstances 

type WorkflowListResponseInstances struct {
	Complete        float64                           `json:"complete"`
	Errored         float64                           `json:"errored"`
	Paused          float64                           `json:"paused"`
	Queued          float64                           `json:"queued"`
	Running         float64                           `json:"running"`
	Terminated      float64                           `json:"terminated"`
	Unknown         float64                           `json:"unknown"`
	Waiting         float64                           `json:"waiting"`
	WaitingForPause float64                           `json:"waitingForPause"`
	JSON            workflowListResponseInstancesJSON `json:"-"`
}

func (*WorkflowListResponseInstances) UnmarshalJSON 

func (r *WorkflowListResponseInstances) UnmarshalJSON(data []byte) (err error)

type WorkflowService 

type WorkflowService struct {
	Options   []option.RequestOption
	Instances *InstanceService
	Versions  *VersionService
}

WorkflowService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWorkflowService method instead.

func NewWorkflowService 

func NewWorkflowService(opts ...option.RequestOption) (r *WorkflowService)

NewWorkflowService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*WorkflowService) Get 

func (r *WorkflowService) Get(ctx context.Context, workflowName string, query WorkflowGetParams, opts ...option.RequestOption) (res *WorkflowGetResponse, err error)

Get Workflow details

func (*WorkflowService) List 

func (r *WorkflowService) List(ctx context.Context, params WorkflowListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[WorkflowListResponse], err error)

List all Workflows

func (*WorkflowService) ListAutoPaging 

func (r *WorkflowService) ListAutoPaging(ctx context.Context, params WorkflowListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[WorkflowListResponse]

List all Workflows

func (*WorkflowService) Update 

func (r *WorkflowService) Update(ctx context.Context, workflowName string, params WorkflowUpdateParams, opts ...option.RequestOption) (res *WorkflowUpdateResponse, err error)

Create/modify Workflow

type WorkflowUpdateParams 

type WorkflowUpdateParams struct {
	AccountID  param.Field[string] `path:"account_id,required"`
	ClassName  param.Field[string] `json:"class_name,required"`
	ScriptName param.Field[string] `json:"script_name,required"`
}

func (WorkflowUpdateParams) MarshalJSON 

func (r WorkflowUpdateParams) MarshalJSON() (data []byte, err error)

type WorkflowUpdateResponse 

type WorkflowUpdateResponse struct {
	ID          string                     `json:"id,required" format:"uuid"`
	ClassName   string                     `json:"class_name,required"`
	CreatedOn   time.Time                  `json:"created_on,required" format:"date-time"`
	ModifiedOn  time.Time                  `json:"modified_on,required" format:"date-time"`
	Name        string                     `json:"name,required"`
	ScriptName  string                     `json:"script_name,required"`
	TriggeredOn time.Time                  `json:"triggered_on,required,nullable" format:"date-time"`
	VersionID   string                     `json:"version_id,required" format:"uuid"`
	JSON        workflowUpdateResponseJSON `json:"-"`
}

func (*WorkflowUpdateResponse) UnmarshalJSON 

func (r *WorkflowUpdateResponse) UnmarshalJSON(data []byte) (err error)

type WorkflowUpdateResponseEnvelope 

type WorkflowUpdateResponseEnvelope struct {
	Errors     []WorkflowUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []WorkflowUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result     WorkflowUpdateResponse                   `json:"result,required"`
	Success    WorkflowUpdateResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo WorkflowUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       workflowUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*WorkflowUpdateResponseEnvelope) UnmarshalJSON 

func (r *WorkflowUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type WorkflowUpdateResponseEnvelopeErrors 

type WorkflowUpdateResponseEnvelopeErrors struct {
	Code    float64                                  `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    workflowUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*WorkflowUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *WorkflowUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type WorkflowUpdateResponseEnvelopeMessages 

type WorkflowUpdateResponseEnvelopeMessages struct {
	Code    float64                                    `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    workflowUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*WorkflowUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *WorkflowUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type WorkflowUpdateResponseEnvelopeResultInfo 

type WorkflowUpdateResponseEnvelopeResultInfo struct {
	Count      float64                                      `json:"count,required"`
	Page       float64                                      `json:"page,required"`
	PerPage    float64                                      `json:"per_page,required"`
	TotalCount float64                                      `json:"total_count,required"`
	JSON       workflowUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*WorkflowUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *WorkflowUpdateResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type WorkflowUpdateResponseEnvelopeSuccess 

type WorkflowUpdateResponseEnvelopeSuccess bool
const (
	WorkflowUpdateResponseEnvelopeSuccessTrue WorkflowUpdateResponseEnvelopeSuccess = true
)

func (WorkflowUpdateResponseEnvelopeSuccess) IsKnown 

func (r WorkflowUpdateResponseEnvelopeSuccess) IsKnown() bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.