Movatterモバイル変換

[0]ホーム
URL:

workflows

package
v4.6.0Latest Latest
Warning

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

Go to latest Published: Jul 10, 2025 License:Apache-2.0Imports:16Imported by:1

Details

Repository

github.com/cloudflare/cloudflare-go

Links

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 CloudflareTunnelTunTypeMagic =shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP =shared.CloudflareTunnelTunTypeWARP

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 RatePlanIDBusiness =shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise =shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree =shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite =shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness =shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise =shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree =shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro =shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro =shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus =shared.RatePlanIDProPlus

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

typeASN

type ASN =shared.ASN

This is an alias to an internal type.

typeASNParam

type ASNParam =shared.ASNParam

This is an alias to an internal type.

typeAuditLog

type AuditLog =shared.AuditLog

This is an alias to an internal type.

typeAuditLogAction

type AuditLogAction =shared.AuditLogAction

This is an alias to an internal type.

typeAuditLogActor

type AuditLogActor =shared.AuditLogActor

This is an alias to an internal type.

typeAuditLogActorType

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.

typeAuditLogOwner

type AuditLogOwner =shared.AuditLogOwner

This is an alias to an internal type.

typeAuditLogResource

type AuditLogResource =shared.AuditLogResource

This is an alias to an internal type.

typeCertificateCA

type CertificateCA =shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

typeCertificateRequestType

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.

typeCloudflareTunnel

type CloudflareTunnel =shared.CloudflareTunnel

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

This is an alias to an internal type.

typeCloudflareTunnelConnection

type CloudflareTunnelConnection =shared.CloudflareTunnelConnection

This is an alias to an internal type.

typeCloudflareTunnelStatus

type CloudflareTunnelStatus =shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never beenrun), `degraded` (tunnel is active and able to serve traffic but in an unhealthystate), `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.

typeCloudflareTunnelTunType

type CloudflareTunnelTunType =shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

typeError

type Error =apierror.Error

typeErrorData

type ErrorData =shared.ErrorData

This is an alias to an internal type.

typeErrorDataSourceadded inv4.2.0

type ErrorDataSource =shared.ErrorDataSource

This is an alias to an internal type.

typeInstanceBulkParamsadded inv4.2.0

type InstanceBulkParams struct {AccountIDparam.Field[string]      `path:"account_id,required"`Body      []InstanceBulkParamsBody `json:"body"`}

func (InstanceBulkParams)MarshalJSONadded inv4.2.0

func (rInstanceBulkParams) MarshalJSON() (data []byte, errerror)

typeInstanceBulkParamsBodyadded inv4.2.0

type InstanceBulkParamsBody struct {InstanceIDparam.Field[string]      `json:"instance_id"`InstanceRetentionparam.Field[interface{}] `json:"instance_retention"`Paramsparam.Field[interface{}] `json:"params"`}

func (InstanceBulkParamsBody)MarshalJSONadded inv4.2.0

func (rInstanceBulkParamsBody) MarshalJSON() (data []byte, errerror)

typeInstanceBulkResponseadded inv4.2.0

type InstanceBulkResponse struct {IDstring                     `json:"id,required"`StatusInstanceBulkResponseStatus `json:"status,required"`VersionIDstring                     `json:"version_id,required" format:"uuid"`WorkflowIDstring                     `json:"workflow_id,required" format:"uuid"`JSON       instanceBulkResponseJSON   `json:"-"`}

func (*InstanceBulkResponse)UnmarshalJSONadded inv4.2.0

func (r *InstanceBulkResponse) UnmarshalJSON(data []byte) (errerror)

typeInstanceBulkResponseStatusadded inv4.2.0

type InstanceBulkResponseStatusstring
const (InstanceBulkResponseStatusQueuedInstanceBulkResponseStatus = "queued"InstanceBulkResponseStatusRunningInstanceBulkResponseStatus = "running"InstanceBulkResponseStatusPausedInstanceBulkResponseStatus = "paused"InstanceBulkResponseStatusErroredInstanceBulkResponseStatus = "errored"InstanceBulkResponseStatusTerminatedInstanceBulkResponseStatus = "terminated"InstanceBulkResponseStatusCompleteInstanceBulkResponseStatus = "complete"InstanceBulkResponseStatusWaitingForPauseInstanceBulkResponseStatus = "waitingForPause"InstanceBulkResponseStatusWaitingInstanceBulkResponseStatus = "waiting")

func (InstanceBulkResponseStatus)IsKnownadded inv4.2.0

typeInstanceEventNewParamsadded inv4.3.0

type InstanceEventNewParams struct {AccountIDparam.Field[string] `path:"account_id,required"`Body      interface{}         `json:"body"`}

func (InstanceEventNewParams)MarshalJSONadded inv4.3.0

func (rInstanceEventNewParams) MarshalJSON() (data []byte, errerror)

typeInstanceEventNewResponseadded inv4.3.0

type InstanceEventNewResponse = interface{}

typeInstanceEventNewResponseEnvelopeadded inv4.3.0

type InstanceEventNewResponseEnvelope struct {Errors     []InstanceEventNewResponseEnvelopeErrors   `json:"errors,required"`Messages   []InstanceEventNewResponseEnvelopeMessages `json:"messages,required"`SuccessInstanceEventNewResponseEnvelopeSuccess    `json:"success,required"`ResultInstanceEventNewResponse                   `json:"result"`ResultInfoInstanceEventNewResponseEnvelopeResultInfo `json:"result_info"`JSON       instanceEventNewResponseEnvelopeJSON       `json:"-"`}

func (*InstanceEventNewResponseEnvelope)UnmarshalJSONadded inv4.3.0

func (r *InstanceEventNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeInstanceEventNewResponseEnvelopeErrorsadded inv4.3.0

type InstanceEventNewResponseEnvelopeErrors struct {Codefloat64                                    `json:"code,required"`Messagestring                                     `json:"message,required"`JSON    instanceEventNewResponseEnvelopeErrorsJSON `json:"-"`}

func (*InstanceEventNewResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *InstanceEventNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeInstanceEventNewResponseEnvelopeMessagesadded inv4.3.0

type InstanceEventNewResponseEnvelopeMessages struct {Codefloat64                                      `json:"code,required"`Messagestring                                       `json:"message,required"`JSON    instanceEventNewResponseEnvelopeMessagesJSON `json:"-"`}

func (*InstanceEventNewResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *InstanceEventNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeInstanceEventNewResponseEnvelopeResultInfoadded inv4.3.0

type InstanceEventNewResponseEnvelopeResultInfo struct {Countfloat64                                        `json:"count,required"`Pagefloat64                                        `json:"page,required"`PerPagefloat64                                        `json:"per_page,required"`TotalCountfloat64                                        `json:"total_count,required"`JSON       instanceEventNewResponseEnvelopeResultInfoJSON `json:"-"`}

func (*InstanceEventNewResponseEnvelopeResultInfo)UnmarshalJSONadded inv4.3.0

func (r *InstanceEventNewResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeInstanceEventNewResponseEnvelopeSuccessadded inv4.3.0

type InstanceEventNewResponseEnvelopeSuccessbool
const (InstanceEventNewResponseEnvelopeSuccessTrueInstanceEventNewResponseEnvelopeSuccess =true)

func (InstanceEventNewResponseEnvelopeSuccess)IsKnownadded inv4.3.0

typeInstanceEventServiceadded inv4.3.0

type InstanceEventService struct {Options []option.RequestOption}

InstanceEventService contains methods and other services that help withinteracting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewInstanceEventService method instead.

funcNewInstanceEventServiceadded inv4.3.0

func NewInstanceEventService(opts ...option.RequestOption) (r *InstanceEventService)

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

func (*InstanceEventService)Newadded inv4.3.0

func (r *InstanceEventService) New(ctxcontext.Context, workflowNamestring, instanceIDstring, eventTypestring, paramsInstanceEventNewParams, opts ...option.RequestOption) (res *InstanceEventNewResponse, errerror)

Send event to instance

typeInstanceGetParams

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

typeInstanceGetResponse

type InstanceGetResponse struct {Endtime.Time                      `json:"end,required,nullable" format:"date-time"`ErrorInstanceGetResponseError       `json:"error,required,nullable"`OutputInstanceGetResponseOutputUnion `json:"output,required"`Params    interface{}                    `json:"params,required"`Queuedtime.Time                      `json:"queued,required" format:"date-time"`Starttime.Time                      `json:"start,required,nullable" format:"date-time"`StatusInstanceGetResponseStatus      `json:"status,required"`Steps     []InstanceGetResponseStep      `json:"steps,required"`Successbool                           `json:"success,required,nullable"`TriggerInstanceGetResponseTrigger     `json:"trigger,required"`VersionIDstring                         `json:"versionId,required" format:"uuid"`JSON      instanceGetResponseJSON        `json:"-"`}

func (*InstanceGetResponse)UnmarshalJSON

func (r *InstanceGetResponse) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseEnvelope

type InstanceGetResponseEnvelope struct {Errors     []InstanceGetResponseEnvelopeErrors   `json:"errors,required"`Messages   []InstanceGetResponseEnvelopeMessages `json:"messages,required"`ResultInstanceGetResponse                   `json:"result,required"`SuccessInstanceGetResponseEnvelopeSuccess    `json:"success,required"`ResultInfoInstanceGetResponseEnvelopeResultInfo `json:"result_info"`JSON       instanceGetResponseEnvelopeJSON       `json:"-"`}

func (*InstanceGetResponseEnvelope)UnmarshalJSON

func (r *InstanceGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseEnvelopeErrors

type InstanceGetResponseEnvelopeErrors struct {Codefloat64                               `json:"code,required"`Messagestring                                `json:"message,required"`JSON    instanceGetResponseEnvelopeErrorsJSON `json:"-"`}

func (*InstanceGetResponseEnvelopeErrors)UnmarshalJSON

func (r *InstanceGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseEnvelopeMessages

type InstanceGetResponseEnvelopeMessages struct {Codefloat64                                 `json:"code,required"`Messagestring                                  `json:"message,required"`JSON    instanceGetResponseEnvelopeMessagesJSON `json:"-"`}

func (*InstanceGetResponseEnvelopeMessages)UnmarshalJSON

func (r *InstanceGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseEnvelopeResultInfo

type InstanceGetResponseEnvelopeResultInfo struct {Countfloat64                                   `json:"count,required"`Pagefloat64                                   `json:"page,required"`PerPagefloat64                                   `json:"per_page,required"`TotalCountfloat64                                   `json:"total_count,required"`JSON       instanceGetResponseEnvelopeResultInfoJSON `json:"-"`}

func (*InstanceGetResponseEnvelopeResultInfo)UnmarshalJSON

func (r *InstanceGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseEnvelopeSuccess

type InstanceGetResponseEnvelopeSuccessbool
const (InstanceGetResponseEnvelopeSuccessTrueInstanceGetResponseEnvelopeSuccess =true)

func (InstanceGetResponseEnvelopeSuccess)IsKnown

typeInstanceGetResponseError

type InstanceGetResponseError struct {Messagestring                       `json:"message,required"`Namestring                       `json:"name,required"`JSON    instanceGetResponseErrorJSON `json:"-"`}

func (*InstanceGetResponseError)UnmarshalJSON

func (r *InstanceGetResponseError) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseOutputUnion

type InstanceGetResponseOutputUnion interface {ImplementsInstanceGetResponseOutputUnion()}

Union satisfied byshared.UnionString orshared.UnionFloat.

typeInstanceGetResponseStatus

type InstanceGetResponseStatusstring
const (InstanceGetResponseStatusQueuedInstanceGetResponseStatus = "queued"InstanceGetResponseStatusRunningInstanceGetResponseStatus = "running"InstanceGetResponseStatusPausedInstanceGetResponseStatus = "paused"InstanceGetResponseStatusErroredInstanceGetResponseStatus = "errored"InstanceGetResponseStatusTerminatedInstanceGetResponseStatus = "terminated"InstanceGetResponseStatusCompleteInstanceGetResponseStatus = "complete"InstanceGetResponseStatusWaitingForPauseInstanceGetResponseStatus = "waitingForPause"InstanceGetResponseStatusWaitingInstanceGetResponseStatus = "waiting")

func (InstanceGetResponseStatus)IsKnown

typeInstanceGetResponseStep

type InstanceGetResponseStep struct {TypeInstanceGetResponseStepsType `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"`Endtime.Time   `json:"end,nullable" format:"date-time"`// This field can have the runtime type of [InstanceGetResponseStepsObjectError].Error    interface{} `json:"error"`Finishedbool        `json:"finished"`Namestring      `json:"name"`// This field can have the runtime type of [interface{}].Output  interface{} `json:"output"`Starttime.Time   `json:"start" format:"date-time"`Successbool        `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

AsUnion returns aInstanceGetResponseStepsUnion interface which you can castto the specific types for more type safety.

Possible runtime types of the union areInstanceGetResponseStepsObject,InstanceGetResponseStepsObject,InstanceGetResponseStepsObject,InstanceGetResponseStepsObject.

func (*InstanceGetResponseStep)UnmarshalJSON

func (r *InstanceGetResponseStep) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseStepsObject

type InstanceGetResponseStepsObject struct {Attempts []InstanceGetResponseStepsObjectAttempt `json:"attempts,required"`ConfigInstanceGetResponseStepsObjectConfig    `json:"config,required"`Endtime.Time                               `json:"end,required,nullable" format:"date-time"`Namestring                                  `json:"name,required"`Output   interface{}                             `json:"output,required"`Starttime.Time                               `json:"start,required" format:"date-time"`Successbool                                    `json:"success,required,nullable"`TypeInstanceGetResponseStepsObjectType      `json:"type,required"`JSON     instanceGetResponseStepsObjectJSON      `json:"-"`}

func (*InstanceGetResponseStepsObject)UnmarshalJSON

func (r *InstanceGetResponseStepsObject) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseStepsObjectAttempt

type InstanceGetResponseStepsObjectAttempt struct {Endtime.Time                                   `json:"end,required,nullable" format:"date-time"`ErrorInstanceGetResponseStepsObjectAttemptsError `json:"error,required,nullable"`Starttime.Time                                   `json:"start,required" format:"date-time"`Successbool                                        `json:"success,required,nullable"`JSON    instanceGetResponseStepsObjectAttemptJSON   `json:"-"`}

func (*InstanceGetResponseStepsObjectAttempt)UnmarshalJSON

func (r *InstanceGetResponseStepsObjectAttempt) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseStepsObjectAttemptsError

type InstanceGetResponseStepsObjectAttemptsError struct {Messagestring                                          `json:"message,required"`Namestring                                          `json:"name,required"`JSON    instanceGetResponseStepsObjectAttemptsErrorJSON `json:"-"`}

func (*InstanceGetResponseStepsObjectAttemptsError)UnmarshalJSON

func (r *InstanceGetResponseStepsObjectAttemptsError) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseStepsObjectConfig

type InstanceGetResponseStepsObjectConfig struct {RetriesInstanceGetResponseStepsObjectConfigRetries `json:"retries,required"`Timeout interface{}                                 `json:"timeout,required"`JSON    instanceGetResponseStepsObjectConfigJSON    `json:"-"`}

func (*InstanceGetResponseStepsObjectConfig)UnmarshalJSON

func (r *InstanceGetResponseStepsObjectConfig) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseStepsObjectConfigRetries

type InstanceGetResponseStepsObjectConfigRetries struct {Delay   interface{}                                        `json:"delay,required"`Limitfloat64                                            `json:"limit,required"`BackoffInstanceGetResponseStepsObjectConfigRetriesBackoff `json:"backoff"`JSON    instanceGetResponseStepsObjectConfigRetriesJSON    `json:"-"`}

func (*InstanceGetResponseStepsObjectConfigRetries)UnmarshalJSON

func (r *InstanceGetResponseStepsObjectConfigRetries) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseStepsObjectConfigRetriesBackoff

type InstanceGetResponseStepsObjectConfigRetriesBackoffstring
const (InstanceGetResponseStepsObjectConfigRetriesBackoffConstantInstanceGetResponseStepsObjectConfigRetriesBackoff = "constant"InstanceGetResponseStepsObjectConfigRetriesBackoffLinearInstanceGetResponseStepsObjectConfigRetriesBackoff = "linear"InstanceGetResponseStepsObjectConfigRetriesBackoffExponentialInstanceGetResponseStepsObjectConfigRetriesBackoff = "exponential")

func (InstanceGetResponseStepsObjectConfigRetriesBackoff)IsKnown

typeInstanceGetResponseStepsObjectType

type InstanceGetResponseStepsObjectTypestring
const (InstanceGetResponseStepsObjectTypeStepInstanceGetResponseStepsObjectType = "step")

func (InstanceGetResponseStepsObjectType)IsKnown

typeInstanceGetResponseStepsType

type InstanceGetResponseStepsTypestring
const (InstanceGetResponseStepsTypeStepInstanceGetResponseStepsType = "step"InstanceGetResponseStepsTypeSleepInstanceGetResponseStepsType = "sleep"InstanceGetResponseStepsTypeTerminationInstanceGetResponseStepsType = "termination"InstanceGetResponseStepsTypeWaitForEventInstanceGetResponseStepsType = "waitForEvent")

func (InstanceGetResponseStepsType)IsKnown

typeInstanceGetResponseStepsUnion

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

Union satisfied byInstanceGetResponseStepsObject,InstanceGetResponseStepsObject,InstanceGetResponseStepsObject orInstanceGetResponseStepsObject.

typeInstanceGetResponseTrigger

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

func (*InstanceGetResponseTrigger)UnmarshalJSON

func (r *InstanceGetResponseTrigger) UnmarshalJSON(data []byte) (errerror)

typeInstanceGetResponseTriggerSource

type InstanceGetResponseTriggerSourcestring
const (InstanceGetResponseTriggerSourceUnknownInstanceGetResponseTriggerSource = "unknown"InstanceGetResponseTriggerSourceAPIInstanceGetResponseTriggerSource = "api"InstanceGetResponseTriggerSourceBindingInstanceGetResponseTriggerSource = "binding"InstanceGetResponseTriggerSourceEventInstanceGetResponseTriggerSource = "event"InstanceGetResponseTriggerSourceCronInstanceGetResponseTriggerSource = "cron")

func (InstanceGetResponseTriggerSource)IsKnown

typeInstanceListParams

type InstanceListParams struct {AccountIDparam.Field[string] `path:"account_id,required"`// Accepts ISO 8601 with no timezone offsets and in UTC.DateEndparam.Field[time.Time] `query:"date_end" format:"date-time"`// Accepts ISO 8601 with no timezone offsets and in UTC.DateStartparam.Field[time.Time]                `query:"date_start" format:"date-time"`Pageparam.Field[float64]                  `query:"page"`PerPageparam.Field[float64]                  `query:"per_page"`Statusparam.Field[InstanceListParamsStatus] `query:"status"`}

func (InstanceListParams)URLQuery

func (rInstanceListParams) URLQuery() (vurl.Values)

URLQuery serializesInstanceListParams's query parameters as `url.Values`.

typeInstanceListParamsStatus

type InstanceListParamsStatusstring
const (InstanceListParamsStatusQueuedInstanceListParamsStatus = "queued"InstanceListParamsStatusRunningInstanceListParamsStatus = "running"InstanceListParamsStatusPausedInstanceListParamsStatus = "paused"InstanceListParamsStatusErroredInstanceListParamsStatus = "errored"InstanceListParamsStatusTerminatedInstanceListParamsStatus = "terminated"InstanceListParamsStatusCompleteInstanceListParamsStatus = "complete"InstanceListParamsStatusWaitingForPauseInstanceListParamsStatus = "waitingForPause"InstanceListParamsStatusWaitingInstanceListParamsStatus = "waiting")

func (InstanceListParamsStatus)IsKnown

typeInstanceListResponse

type InstanceListResponse struct {IDstring                     `json:"id,required"`CreatedOntime.Time                  `json:"created_on,required" format:"date-time"`EndedOntime.Time                  `json:"ended_on,required,nullable" format:"date-time"`ModifiedOntime.Time                  `json:"modified_on,required" format:"date-time"`StartedOntime.Time                  `json:"started_on,required,nullable" format:"date-time"`StatusInstanceListResponseStatus `json:"status,required"`VersionIDstring                     `json:"version_id,required" format:"uuid"`WorkflowIDstring                     `json:"workflow_id,required" format:"uuid"`JSON       instanceListResponseJSON   `json:"-"`}

func (*InstanceListResponse)UnmarshalJSON

func (r *InstanceListResponse) UnmarshalJSON(data []byte) (errerror)

typeInstanceListResponseStatus

type InstanceListResponseStatusstring
const (InstanceListResponseStatusQueuedInstanceListResponseStatus = "queued"InstanceListResponseStatusRunningInstanceListResponseStatus = "running"InstanceListResponseStatusPausedInstanceListResponseStatus = "paused"InstanceListResponseStatusErroredInstanceListResponseStatus = "errored"InstanceListResponseStatusTerminatedInstanceListResponseStatus = "terminated"InstanceListResponseStatusCompleteInstanceListResponseStatus = "complete"InstanceListResponseStatusWaitingForPauseInstanceListResponseStatus = "waitingForPause"InstanceListResponseStatusWaitingInstanceListResponseStatus = "waiting")

func (InstanceListResponseStatus)IsKnown

typeInstanceNewParams

type InstanceNewParams struct {AccountIDparam.Field[string]      `path:"account_id,required"`InstanceIDparam.Field[string]      `json:"instance_id"`InstanceRetentionparam.Field[interface{}] `json:"instance_retention"`Paramsparam.Field[interface{}] `json:"params"`}

func (InstanceNewParams)MarshalJSON

func (rInstanceNewParams) MarshalJSON() (data []byte, errerror)

typeInstanceNewResponse

type InstanceNewResponse struct {IDstring                    `json:"id,required"`StatusInstanceNewResponseStatus `json:"status,required"`VersionIDstring                    `json:"version_id,required" format:"uuid"`WorkflowIDstring                    `json:"workflow_id,required" format:"uuid"`JSON       instanceNewResponseJSON   `json:"-"`}

func (*InstanceNewResponse)UnmarshalJSON

func (r *InstanceNewResponse) UnmarshalJSON(data []byte) (errerror)

typeInstanceNewResponseEnvelope

type InstanceNewResponseEnvelope struct {Errors     []InstanceNewResponseEnvelopeErrors   `json:"errors,required"`Messages   []InstanceNewResponseEnvelopeMessages `json:"messages,required"`ResultInstanceNewResponse                   `json:"result,required"`SuccessInstanceNewResponseEnvelopeSuccess    `json:"success,required"`ResultInfoInstanceNewResponseEnvelopeResultInfo `json:"result_info"`JSON       instanceNewResponseEnvelopeJSON       `json:"-"`}

func (*InstanceNewResponseEnvelope)UnmarshalJSON

func (r *InstanceNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeInstanceNewResponseEnvelopeErrors

type InstanceNewResponseEnvelopeErrors struct {Codefloat64                               `json:"code,required"`Messagestring                                `json:"message,required"`JSON    instanceNewResponseEnvelopeErrorsJSON `json:"-"`}

func (*InstanceNewResponseEnvelopeErrors)UnmarshalJSON

func (r *InstanceNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeInstanceNewResponseEnvelopeMessages

type InstanceNewResponseEnvelopeMessages struct {Codefloat64                                 `json:"code,required"`Messagestring                                  `json:"message,required"`JSON    instanceNewResponseEnvelopeMessagesJSON `json:"-"`}

func (*InstanceNewResponseEnvelopeMessages)UnmarshalJSON

func (r *InstanceNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeInstanceNewResponseEnvelopeResultInfo

type InstanceNewResponseEnvelopeResultInfo struct {Countfloat64                                   `json:"count,required"`Pagefloat64                                   `json:"page,required"`PerPagefloat64                                   `json:"per_page,required"`TotalCountfloat64                                   `json:"total_count,required"`JSON       instanceNewResponseEnvelopeResultInfoJSON `json:"-"`}

func (*InstanceNewResponseEnvelopeResultInfo)UnmarshalJSON

func (r *InstanceNewResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeInstanceNewResponseEnvelopeSuccess

type InstanceNewResponseEnvelopeSuccessbool
const (InstanceNewResponseEnvelopeSuccessTrueInstanceNewResponseEnvelopeSuccess =true)

func (InstanceNewResponseEnvelopeSuccess)IsKnown

typeInstanceNewResponseStatus

type InstanceNewResponseStatusstring
const (InstanceNewResponseStatusQueuedInstanceNewResponseStatus = "queued"InstanceNewResponseStatusRunningInstanceNewResponseStatus = "running"InstanceNewResponseStatusPausedInstanceNewResponseStatus = "paused"InstanceNewResponseStatusErroredInstanceNewResponseStatus = "errored"InstanceNewResponseStatusTerminatedInstanceNewResponseStatus = "terminated"InstanceNewResponseStatusCompleteInstanceNewResponseStatus = "complete"InstanceNewResponseStatusWaitingForPauseInstanceNewResponseStatus = "waitingForPause"InstanceNewResponseStatusWaitingInstanceNewResponseStatus = "waiting")

func (InstanceNewResponseStatus)IsKnown

typeInstanceService

type InstanceService struct {Options []option.RequestOptionStatus  *InstanceStatusServiceEvents  *InstanceEventService}

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

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewInstanceService method instead.

funcNewInstanceService

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

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

func (*InstanceService)Bulkadded inv4.2.0

Batch create new Workflow instances

func (*InstanceService)BulkAutoPagingadded inv4.2.0

Batch create new Workflow instances

func (*InstanceService)Get

func (r *InstanceService) Get(ctxcontext.Context, workflowNamestring, instanceIDstring, queryInstanceGetParams, opts ...option.RequestOption) (res *InstanceGetResponse, errerror)

Get logs and status from instance

func (*InstanceService)List

List of workflow instances

func (*InstanceService)ListAutoPaging

List of workflow instances

func (*InstanceService)New

func (r *InstanceService) New(ctxcontext.Context, workflowNamestring, paramsInstanceNewParams, opts ...option.RequestOption) (res *InstanceNewResponse, errerror)

Create a new workflow instance

typeInstanceStatusEditParams

type InstanceStatusEditParams struct {AccountIDparam.Field[string] `path:"account_id,required"`// Apply action to instance.Statusparam.Field[InstanceStatusEditParamsStatus] `json:"status,required"`}

func (InstanceStatusEditParams)MarshalJSON

func (rInstanceStatusEditParams) MarshalJSON() (data []byte, errerror)

typeInstanceStatusEditParamsStatus

type InstanceStatusEditParamsStatusstring

Apply action to instance.

const (InstanceStatusEditParamsStatusResumeInstanceStatusEditParamsStatus = "resume"InstanceStatusEditParamsStatusPauseInstanceStatusEditParamsStatus = "pause"InstanceStatusEditParamsStatusTerminateInstanceStatusEditParamsStatus = "terminate")

func (InstanceStatusEditParamsStatus)IsKnown

typeInstanceStatusEditResponse

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

func (*InstanceStatusEditResponse)UnmarshalJSON

func (r *InstanceStatusEditResponse) UnmarshalJSON(data []byte) (errerror)

typeInstanceStatusEditResponseEnvelope

type InstanceStatusEditResponseEnvelope struct {Errors     []InstanceStatusEditResponseEnvelopeErrors   `json:"errors,required"`Messages   []InstanceStatusEditResponseEnvelopeMessages `json:"messages,required"`ResultInstanceStatusEditResponse                   `json:"result,required"`SuccessInstanceStatusEditResponseEnvelopeSuccess    `json:"success,required"`ResultInfoInstanceStatusEditResponseEnvelopeResultInfo `json:"result_info"`JSON       instanceStatusEditResponseEnvelopeJSON       `json:"-"`}

func (*InstanceStatusEditResponseEnvelope)UnmarshalJSON

func (r *InstanceStatusEditResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeInstanceStatusEditResponseEnvelopeErrors

type InstanceStatusEditResponseEnvelopeErrors struct {Codefloat64                                      `json:"code,required"`Messagestring                                       `json:"message,required"`JSON    instanceStatusEditResponseEnvelopeErrorsJSON `json:"-"`}

func (*InstanceStatusEditResponseEnvelopeErrors)UnmarshalJSON

func (r *InstanceStatusEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeInstanceStatusEditResponseEnvelopeMessages

type InstanceStatusEditResponseEnvelopeMessages struct {Codefloat64                                        `json:"code,required"`Messagestring                                         `json:"message,required"`JSON    instanceStatusEditResponseEnvelopeMessagesJSON `json:"-"`}

func (*InstanceStatusEditResponseEnvelopeMessages)UnmarshalJSON

func (r *InstanceStatusEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeInstanceStatusEditResponseEnvelopeResultInfo

type InstanceStatusEditResponseEnvelopeResultInfo struct {Countfloat64                                          `json:"count,required"`Pagefloat64                                          `json:"page,required"`PerPagefloat64                                          `json:"per_page,required"`TotalCountfloat64                                          `json:"total_count,required"`JSON       instanceStatusEditResponseEnvelopeResultInfoJSON `json:"-"`}

func (*InstanceStatusEditResponseEnvelopeResultInfo)UnmarshalJSON

func (r *InstanceStatusEditResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeInstanceStatusEditResponseEnvelopeSuccess

type InstanceStatusEditResponseEnvelopeSuccessbool
const (InstanceStatusEditResponseEnvelopeSuccessTrueInstanceStatusEditResponseEnvelopeSuccess =true)

func (InstanceStatusEditResponseEnvelopeSuccess)IsKnown

typeInstanceStatusEditResponseStatus

type InstanceStatusEditResponseStatusstring
const (InstanceStatusEditResponseStatusQueuedInstanceStatusEditResponseStatus = "queued"InstanceStatusEditResponseStatusRunningInstanceStatusEditResponseStatus = "running"InstanceStatusEditResponseStatusPausedInstanceStatusEditResponseStatus = "paused"InstanceStatusEditResponseStatusErroredInstanceStatusEditResponseStatus = "errored"InstanceStatusEditResponseStatusTerminatedInstanceStatusEditResponseStatus = "terminated"InstanceStatusEditResponseStatusCompleteInstanceStatusEditResponseStatus = "complete"InstanceStatusEditResponseStatusWaitingForPauseInstanceStatusEditResponseStatus = "waitingForPause"InstanceStatusEditResponseStatusWaitingInstanceStatusEditResponseStatus = "waiting")

func (InstanceStatusEditResponseStatus)IsKnown

typeInstanceStatusService

type InstanceStatusService struct {Options []option.RequestOption}

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

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewInstanceStatusService method instead.

funcNewInstanceStatusService

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

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

func (*InstanceStatusService)Edit

Change status of instance

typeMember

type Member =shared.Member

This is an alias to an internal type.

typeMemberPoliciesAccess

type MemberPoliciesAccess =shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup =shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta =shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroup

type MemberPoliciesResourceGroup =shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta =shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope =shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject =shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

typeMemberPolicy

type MemberPolicy =shared.MemberPolicy

This is an alias to an internal type.

typeMemberStatus

type MemberStatus =shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

typeMemberUser

type MemberUser =shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

typePermission

type Permission =shared.Permission

This is an alias to an internal type.

typePermissionGrant

type PermissionGrant =shared.PermissionGrant

This is an alias to an internal type.

typePermissionGrantParam

type PermissionGrantParam =shared.PermissionGrantParam

This is an alias to an internal type.

typeRatePlan

type RatePlan =shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

typeRatePlanIDadded inv4.1.0

type RatePlanID =shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

typeRatePlanParam

type RatePlanParam =shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

typeResponseInfo

type ResponseInfo =shared.ResponseInfo

This is an alias to an internal type.

typeResponseInfoSourceadded inv4.3.0

type ResponseInfoSource =shared.ResponseInfoSource

This is an alias to an internal type.

typeRole

type Role =shared.Role

This is an alias to an internal type.

typeRoleParam

type RoleParam =shared.RoleParam

This is an alias to an internal type.

typeRolePermissions

type RolePermissions =shared.RolePermissions

This is an alias to an internal type.

typeRolePermissionsParam

type RolePermissionsParam =shared.RolePermissionsParam

This is an alias to an internal type.

typeSortDirection

type SortDirection =shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

typeSubscription

type Subscription =shared.Subscription

This is an alias to an internal type.

typeSubscriptionFrequency

type SubscriptionFrequency =shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

typeSubscriptionParam

type SubscriptionParam =shared.SubscriptionParam

This is an alias to an internal type.

typeSubscriptionState

type SubscriptionState =shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

typeToken

type Token =shared.Token

This is an alias to an internal type.

typeTokenCondition

type TokenCondition =shared.TokenCondition

This is an alias to an internal type.

typeTokenConditionCIDRList

type TokenConditionCIDRList =shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionCIDRListParam

type TokenConditionCIDRListParam =shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionParam

type TokenConditionParam =shared.TokenConditionParam

This is an alias to an internal type.

typeTokenConditionRequestIP

type TokenConditionRequestIP =shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

typeTokenConditionRequestIPParam

type TokenConditionRequestIPParam =shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

typeTokenParam

type TokenParam =shared.TokenParam

This is an alias to an internal type.

typeTokenPolicy

type TokenPolicy =shared.TokenPolicy

This is an alias to an internal type.

typeTokenPolicyEffect

type TokenPolicyEffect =shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

typeTokenPolicyParam

type TokenPolicyParam =shared.TokenPolicyParam

This is an alias to an internal type.

typeTokenPolicyPermissionGroup

type TokenPolicyPermissionGroup =shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam =shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta =shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam =shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyResourcesMapadded inv4.6.0

type TokenPolicyResourcesMap =shared.TokenPolicyResourcesMap

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesMapParamadded inv4.6.0

type TokenPolicyResourcesMapParam =shared.TokenPolicyResourcesMapParam

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesUnionadded inv4.6.0

type TokenPolicyResourcesUnion =shared.TokenPolicyResourcesUnion

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

typeTokenPolicyResourcesUnionParamadded inv4.6.0

type TokenPolicyResourcesUnionParam =shared.TokenPolicyResourcesUnionParam

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

typeTokenStatus

type TokenStatus =shared.TokenStatus

Status of the token.

This is an alias to an internal type.

typeTokenValue

type TokenValue =shared.TokenValue

The token value.

This is an alias to an internal type.

typeVersionGetParams

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

typeVersionGetResponse

type VersionGetResponse struct {IDstring                 `json:"id,required" format:"uuid"`ClassNamestring                 `json:"class_name,required"`CreatedOntime.Time              `json:"created_on,required" format:"date-time"`ModifiedOntime.Time              `json:"modified_on,required" format:"date-time"`WorkflowIDstring                 `json:"workflow_id,required" format:"uuid"`JSON       versionGetResponseJSON `json:"-"`}

func (*VersionGetResponse)UnmarshalJSON

func (r *VersionGetResponse) UnmarshalJSON(data []byte) (errerror)

typeVersionGetResponseEnvelope

type VersionGetResponseEnvelope struct {Errors     []VersionGetResponseEnvelopeErrors   `json:"errors,required"`Messages   []VersionGetResponseEnvelopeMessages `json:"messages,required"`ResultVersionGetResponse                   `json:"result,required"`SuccessVersionGetResponseEnvelopeSuccess    `json:"success,required"`ResultInfoVersionGetResponseEnvelopeResultInfo `json:"result_info"`JSON       versionGetResponseEnvelopeJSON       `json:"-"`}

func (*VersionGetResponseEnvelope)UnmarshalJSON

func (r *VersionGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeVersionGetResponseEnvelopeErrors

type VersionGetResponseEnvelopeErrors struct {Codefloat64                              `json:"code,required"`Messagestring                               `json:"message,required"`JSON    versionGetResponseEnvelopeErrorsJSON `json:"-"`}

func (*VersionGetResponseEnvelopeErrors)UnmarshalJSON

func (r *VersionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeVersionGetResponseEnvelopeMessages

type VersionGetResponseEnvelopeMessages struct {Codefloat64                                `json:"code,required"`Messagestring                                 `json:"message,required"`JSON    versionGetResponseEnvelopeMessagesJSON `json:"-"`}

func (*VersionGetResponseEnvelopeMessages)UnmarshalJSON

func (r *VersionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeVersionGetResponseEnvelopeResultInfo

type VersionGetResponseEnvelopeResultInfo struct {Countfloat64                                  `json:"count,required"`Pagefloat64                                  `json:"page,required"`PerPagefloat64                                  `json:"per_page,required"`TotalCountfloat64                                  `json:"total_count,required"`JSON       versionGetResponseEnvelopeResultInfoJSON `json:"-"`}

func (*VersionGetResponseEnvelopeResultInfo)UnmarshalJSON

func (r *VersionGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeVersionGetResponseEnvelopeSuccess

type VersionGetResponseEnvelopeSuccessbool
const (VersionGetResponseEnvelopeSuccessTrueVersionGetResponseEnvelopeSuccess =true)

func (VersionGetResponseEnvelopeSuccess)IsKnown

typeVersionListParams

type VersionListParams struct {AccountIDparam.Field[string]  `path:"account_id,required"`Pageparam.Field[float64] `query:"page"`PerPageparam.Field[float64] `query:"per_page"`}

func (VersionListParams)URLQuery

func (rVersionListParams) URLQuery() (vurl.Values)

URLQuery serializesVersionListParams's query parameters as `url.Values`.

typeVersionListResponse

type VersionListResponse struct {IDstring                  `json:"id,required" format:"uuid"`ClassNamestring                  `json:"class_name,required"`CreatedOntime.Time               `json:"created_on,required" format:"date-time"`ModifiedOntime.Time               `json:"modified_on,required" format:"date-time"`WorkflowIDstring                  `json:"workflow_id,required" format:"uuid"`JSON       versionListResponseJSON `json:"-"`}

func (*VersionListResponse)UnmarshalJSON

func (r *VersionListResponse) UnmarshalJSON(data []byte) (errerror)

typeVersionService

type VersionService struct {Options []option.RequestOption}

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

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewVersionService method instead.

funcNewVersionService

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

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

func (*VersionService)Get

func (r *VersionService) Get(ctxcontext.Context, workflowNamestring, versionIDstring, queryVersionGetParams, opts ...option.RequestOption) (res *VersionGetResponse, errerror)

Get Workflow version details

func (*VersionService)List

List deployed Workflow versions

func (*VersionService)ListAutoPaging

List deployed Workflow versions

typeWorkflowDeleteParamsadded inv4.3.0

type WorkflowDeleteParams struct {AccountIDparam.Field[string] `path:"account_id,required"`}

typeWorkflowDeleteResponseadded inv4.3.0

type WorkflowDeleteResponse struct {StatusWorkflowDeleteResponseStatus `json:"status,required"`Successbool                         `json:"success,required,nullable"`JSON    workflowDeleteResponseJSON   `json:"-"`}

func (*WorkflowDeleteResponse)UnmarshalJSONadded inv4.3.0

func (r *WorkflowDeleteResponse) UnmarshalJSON(data []byte) (errerror)

typeWorkflowDeleteResponseEnvelopeadded inv4.3.0

type WorkflowDeleteResponseEnvelope struct {Errors     []WorkflowDeleteResponseEnvelopeErrors   `json:"errors,required"`Messages   []WorkflowDeleteResponseEnvelopeMessages `json:"messages,required"`ResultWorkflowDeleteResponse                   `json:"result,required"`SuccessWorkflowDeleteResponseEnvelopeSuccess    `json:"success,required"`ResultInfoWorkflowDeleteResponseEnvelopeResultInfo `json:"result_info"`JSON       workflowDeleteResponseEnvelopeJSON       `json:"-"`}

func (*WorkflowDeleteResponseEnvelope)UnmarshalJSONadded inv4.3.0

func (r *WorkflowDeleteResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeWorkflowDeleteResponseEnvelopeErrorsadded inv4.3.0

type WorkflowDeleteResponseEnvelopeErrors struct {Codefloat64                                  `json:"code,required"`Messagestring                                   `json:"message,required"`JSON    workflowDeleteResponseEnvelopeErrorsJSON `json:"-"`}

func (*WorkflowDeleteResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *WorkflowDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeWorkflowDeleteResponseEnvelopeMessagesadded inv4.3.0

type WorkflowDeleteResponseEnvelopeMessages struct {Codefloat64                                    `json:"code,required"`Messagestring                                     `json:"message,required"`JSON    workflowDeleteResponseEnvelopeMessagesJSON `json:"-"`}

func (*WorkflowDeleteResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *WorkflowDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeWorkflowDeleteResponseEnvelopeResultInfoadded inv4.3.0

type WorkflowDeleteResponseEnvelopeResultInfo struct {Countfloat64                                      `json:"count,required"`Pagefloat64                                      `json:"page,required"`PerPagefloat64                                      `json:"per_page,required"`TotalCountfloat64                                      `json:"total_count,required"`JSON       workflowDeleteResponseEnvelopeResultInfoJSON `json:"-"`}

func (*WorkflowDeleteResponseEnvelopeResultInfo)UnmarshalJSONadded inv4.3.0

func (r *WorkflowDeleteResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeWorkflowDeleteResponseEnvelopeSuccessadded inv4.3.0

type WorkflowDeleteResponseEnvelopeSuccessbool
const (WorkflowDeleteResponseEnvelopeSuccessTrueWorkflowDeleteResponseEnvelopeSuccess =true)

func (WorkflowDeleteResponseEnvelopeSuccess)IsKnownadded inv4.3.0

typeWorkflowDeleteResponseStatusadded inv4.3.0

type WorkflowDeleteResponseStatusstring
const (WorkflowDeleteResponseStatusOkWorkflowDeleteResponseStatus = "ok")

func (WorkflowDeleteResponseStatus)IsKnownadded inv4.3.0

typeWorkflowGetParams

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

typeWorkflowGetResponse

type WorkflowGetResponse struct {IDstring                       `json:"id,required" format:"uuid"`ClassNamestring                       `json:"class_name,required"`CreatedOntime.Time                    `json:"created_on,required" format:"date-time"`InstancesWorkflowGetResponseInstances `json:"instances,required"`ModifiedOntime.Time                    `json:"modified_on,required" format:"date-time"`Namestring                       `json:"name,required"`ScriptNamestring                       `json:"script_name,required"`TriggeredOntime.Time                    `json:"triggered_on,required,nullable" format:"date-time"`JSON        workflowGetResponseJSON      `json:"-"`}

func (*WorkflowGetResponse)UnmarshalJSON

func (r *WorkflowGetResponse) UnmarshalJSON(data []byte) (errerror)

typeWorkflowGetResponseEnvelope

type WorkflowGetResponseEnvelope struct {Errors     []WorkflowGetResponseEnvelopeErrors   `json:"errors,required"`Messages   []WorkflowGetResponseEnvelopeMessages `json:"messages,required"`ResultWorkflowGetResponse                   `json:"result,required"`SuccessWorkflowGetResponseEnvelopeSuccess    `json:"success,required"`ResultInfoWorkflowGetResponseEnvelopeResultInfo `json:"result_info"`JSON       workflowGetResponseEnvelopeJSON       `json:"-"`}

func (*WorkflowGetResponseEnvelope)UnmarshalJSON

func (r *WorkflowGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeWorkflowGetResponseEnvelopeErrors

type WorkflowGetResponseEnvelopeErrors struct {Codefloat64                               `json:"code,required"`Messagestring                                `json:"message,required"`JSON    workflowGetResponseEnvelopeErrorsJSON `json:"-"`}

func (*WorkflowGetResponseEnvelopeErrors)UnmarshalJSON

func (r *WorkflowGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeWorkflowGetResponseEnvelopeMessages

type WorkflowGetResponseEnvelopeMessages struct {Codefloat64                                 `json:"code,required"`Messagestring                                  `json:"message,required"`JSON    workflowGetResponseEnvelopeMessagesJSON `json:"-"`}

func (*WorkflowGetResponseEnvelopeMessages)UnmarshalJSON

func (r *WorkflowGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeWorkflowGetResponseEnvelopeResultInfo

type WorkflowGetResponseEnvelopeResultInfo struct {Countfloat64                                   `json:"count,required"`Pagefloat64                                   `json:"page,required"`PerPagefloat64                                   `json:"per_page,required"`TotalCountfloat64                                   `json:"total_count,required"`JSON       workflowGetResponseEnvelopeResultInfoJSON `json:"-"`}

func (*WorkflowGetResponseEnvelopeResultInfo)UnmarshalJSON

func (r *WorkflowGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeWorkflowGetResponseEnvelopeSuccess

type WorkflowGetResponseEnvelopeSuccessbool
const (WorkflowGetResponseEnvelopeSuccessTrueWorkflowGetResponseEnvelopeSuccess =true)

func (WorkflowGetResponseEnvelopeSuccess)IsKnown

typeWorkflowGetResponseInstances

type WorkflowGetResponseInstances struct {Completefloat64                          `json:"complete"`Erroredfloat64                          `json:"errored"`Pausedfloat64                          `json:"paused"`Queuedfloat64                          `json:"queued"`Runningfloat64                          `json:"running"`Terminatedfloat64                          `json:"terminated"`Waitingfloat64                          `json:"waiting"`WaitingForPausefloat64                          `json:"waitingForPause"`JSON            workflowGetResponseInstancesJSON `json:"-"`}

func (*WorkflowGetResponseInstances)UnmarshalJSON

func (r *WorkflowGetResponseInstances) UnmarshalJSON(data []byte) (errerror)

typeWorkflowListParams

type WorkflowListParams struct {AccountIDparam.Field[string]  `path:"account_id,required"`Pageparam.Field[float64] `query:"page"`PerPageparam.Field[float64] `query:"per_page"`// Allows filtering workflows` name.Searchparam.Field[string] `query:"search"`}

func (WorkflowListParams)URLQuery

func (rWorkflowListParams) URLQuery() (vurl.Values)

URLQuery serializesWorkflowListParams's query parameters as `url.Values`.

typeWorkflowListResponse

type WorkflowListResponse struct {IDstring                        `json:"id,required" format:"uuid"`ClassNamestring                        `json:"class_name,required"`CreatedOntime.Time                     `json:"created_on,required" format:"date-time"`InstancesWorkflowListResponseInstances `json:"instances,required"`ModifiedOntime.Time                     `json:"modified_on,required" format:"date-time"`Namestring                        `json:"name,required"`ScriptNamestring                        `json:"script_name,required"`TriggeredOntime.Time                     `json:"triggered_on,required,nullable" format:"date-time"`JSON        workflowListResponseJSON      `json:"-"`}

func (*WorkflowListResponse)UnmarshalJSON

func (r *WorkflowListResponse) UnmarshalJSON(data []byte) (errerror)

typeWorkflowListResponseInstances

type WorkflowListResponseInstances struct {Completefloat64                           `json:"complete"`Erroredfloat64                           `json:"errored"`Pausedfloat64                           `json:"paused"`Queuedfloat64                           `json:"queued"`Runningfloat64                           `json:"running"`Terminatedfloat64                           `json:"terminated"`Waitingfloat64                           `json:"waiting"`WaitingForPausefloat64                           `json:"waitingForPause"`JSON            workflowListResponseInstancesJSON `json:"-"`}

func (*WorkflowListResponseInstances)UnmarshalJSON

func (r *WorkflowListResponseInstances) UnmarshalJSON(data []byte) (errerror)

typeWorkflowService

type WorkflowService struct {Options   []option.RequestOptionInstances *InstanceServiceVersions  *VersionService}

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

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewWorkflowService method instead.

funcNewWorkflowService

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

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

func (*WorkflowService)Deleteadded inv4.3.0

Deletes a Workflow. This only deletes the Workflow and does not delete or modifyany Worker associated to this Workflow or bounded to it.

func (*WorkflowService)Get

func (r *WorkflowService) Get(ctxcontext.Context, workflowNamestring, queryWorkflowGetParams, opts ...option.RequestOption) (res *WorkflowGetResponse, errerror)

Get Workflow details

func (*WorkflowService)List

List all Workflows

func (*WorkflowService)ListAutoPaging

List all Workflows

func (*WorkflowService)Update

func (r *WorkflowService) Update(ctxcontext.Context, workflowNamestring, paramsWorkflowUpdateParams, opts ...option.RequestOption) (res *WorkflowUpdateResponse, errerror)

Create/modify Workflow

typeWorkflowUpdateParams

type WorkflowUpdateParams struct {AccountIDparam.Field[string] `path:"account_id,required"`ClassNameparam.Field[string] `json:"class_name,required"`ScriptNameparam.Field[string] `json:"script_name,required"`}

func (WorkflowUpdateParams)MarshalJSON

func (rWorkflowUpdateParams) MarshalJSON() (data []byte, errerror)

typeWorkflowUpdateResponse

type WorkflowUpdateResponse struct {IDstring                     `json:"id,required" format:"uuid"`ClassNamestring                     `json:"class_name,required"`CreatedOntime.Time                  `json:"created_on,required" format:"date-time"`IsDeletedfloat64                    `json:"is_deleted,required"`ModifiedOntime.Time                  `json:"modified_on,required" format:"date-time"`Namestring                     `json:"name,required"`ScriptNamestring                     `json:"script_name,required"`TerminatorRunningfloat64                    `json:"terminator_running,required"`TriggeredOntime.Time                  `json:"triggered_on,required,nullable" format:"date-time"`VersionIDstring                     `json:"version_id,required" format:"uuid"`JSON              workflowUpdateResponseJSON `json:"-"`}

func (*WorkflowUpdateResponse)UnmarshalJSON

func (r *WorkflowUpdateResponse) UnmarshalJSON(data []byte) (errerror)

typeWorkflowUpdateResponseEnvelope

type WorkflowUpdateResponseEnvelope struct {Errors     []WorkflowUpdateResponseEnvelopeErrors   `json:"errors,required"`Messages   []WorkflowUpdateResponseEnvelopeMessages `json:"messages,required"`ResultWorkflowUpdateResponse                   `json:"result,required"`SuccessWorkflowUpdateResponseEnvelopeSuccess    `json:"success,required"`ResultInfoWorkflowUpdateResponseEnvelopeResultInfo `json:"result_info"`JSON       workflowUpdateResponseEnvelopeJSON       `json:"-"`}

func (*WorkflowUpdateResponseEnvelope)UnmarshalJSON

func (r *WorkflowUpdateResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeWorkflowUpdateResponseEnvelopeErrors

type WorkflowUpdateResponseEnvelopeErrors struct {Codefloat64                                  `json:"code,required"`Messagestring                                   `json:"message,required"`JSON    workflowUpdateResponseEnvelopeErrorsJSON `json:"-"`}

func (*WorkflowUpdateResponseEnvelopeErrors)UnmarshalJSON

func (r *WorkflowUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeWorkflowUpdateResponseEnvelopeMessages

type WorkflowUpdateResponseEnvelopeMessages struct {Codefloat64                                    `json:"code,required"`Messagestring                                     `json:"message,required"`JSON    workflowUpdateResponseEnvelopeMessagesJSON `json:"-"`}

func (*WorkflowUpdateResponseEnvelopeMessages)UnmarshalJSON

func (r *WorkflowUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeWorkflowUpdateResponseEnvelopeResultInfo

type WorkflowUpdateResponseEnvelopeResultInfo struct {Countfloat64                                      `json:"count,required"`Pagefloat64                                      `json:"page,required"`PerPagefloat64                                      `json:"per_page,required"`TotalCountfloat64                                      `json:"total_count,required"`JSON       workflowUpdateResponseEnvelopeResultInfoJSON `json:"-"`}

func (*WorkflowUpdateResponseEnvelopeResultInfo)UnmarshalJSON

func (r *WorkflowUpdateResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (errerror)

typeWorkflowUpdateResponseEnvelopeSuccess

type WorkflowUpdateResponseEnvelopeSuccessbool
const (WorkflowUpdateResponseEnvelopeSuccessTrueWorkflowUpdateResponseEnvelopeSuccess =true)

func (WorkflowUpdateResponseEnvelopeSuccess)IsKnown

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp