event_notifications

package
v3.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 24, 2024 License: Apache-2.0 Imports: 10 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 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.

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 EventNotificationService 

type EventNotificationService struct {
	Options []option.RequestOption
	R2      *R2Service
}

EventNotificationService 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 NewEventNotificationService method instead.

func NewEventNotificationService 

func NewEventNotificationService(opts ...option.RequestOption) (r *EventNotificationService)

NewEventNotificationService 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.

type MemberParam 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

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 MemberUserParam 

type MemberUserParam = shared.MemberUserParam

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 R2ConfigurationGetParams 

type R2ConfigurationGetParams struct {
	// Account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type R2ConfigurationGetResponse 

type R2ConfigurationGetResponse struct {
	// Name of the bucket.
	BucketName string `json:"bucketName"`
	// List of queues associated with the bucket.
	Queues []R2ConfigurationGetResponseQueue `json:"queues"`
	JSON   r2ConfigurationGetResponseJSON    `json:"-"`
}

func (*R2ConfigurationGetResponse) UnmarshalJSON added in v3.1.0 

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

type R2ConfigurationGetResponseEnvelope 

type R2ConfigurationGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo      `json:"errors,required"`
	Messages []string                   `json:"messages,required"`
	Result   R2ConfigurationGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success R2ConfigurationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    r2ConfigurationGetResponseEnvelopeJSON    `json:"-"`
}

func (*R2ConfigurationGetResponseEnvelope) UnmarshalJSON 

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

type R2ConfigurationGetResponseEnvelopeSuccess 

type R2ConfigurationGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	R2ConfigurationGetResponseEnvelopeSuccessTrue R2ConfigurationGetResponseEnvelopeSuccess = true
)

func (R2ConfigurationGetResponseEnvelopeSuccess) IsKnown 

func (r R2ConfigurationGetResponseEnvelopeSuccess) IsKnown() bool

type R2ConfigurationGetResponseQueue added in v3.1.0 

type R2ConfigurationGetResponseQueue struct {
	// Queue ID
	QueueID string `json:"queueId"`
	// Name of the queue
	QueueName string                                 `json:"queueName"`
	Rules     []R2ConfigurationGetResponseQueuesRule `json:"rules"`
	JSON      r2ConfigurationGetResponseQueueJSON    `json:"-"`
}

func (*R2ConfigurationGetResponseQueue) UnmarshalJSON added in v3.1.0 

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

type R2ConfigurationGetResponseQueuesRule added in v3.1.0 

type R2ConfigurationGetResponseQueuesRule struct {
	// Array of R2 object actions that will trigger notifications
	Actions []R2ConfigurationGetResponseQueuesRulesAction `json:"actions,required"`
	// Timestamp when the rule was created
	CreatedAt string `json:"createdAt"`
	// Notifications will be sent only for objects with this prefix
	Prefix string `json:"prefix"`
	// Rule ID
	RuleID string `json:"ruleId"`
	// Notifications will be sent only for objects with this suffix
	Suffix string                                   `json:"suffix"`
	JSON   r2ConfigurationGetResponseQueuesRuleJSON `json:"-"`
}

func (*R2ConfigurationGetResponseQueuesRule) UnmarshalJSON added in v3.1.0 

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

type R2ConfigurationGetResponseQueuesRulesAction added in v3.1.0 

type R2ConfigurationGetResponseQueuesRulesAction string
const (
	R2ConfigurationGetResponseQueuesRulesActionPutObject               R2ConfigurationGetResponseQueuesRulesAction = "PutObject"
	R2ConfigurationGetResponseQueuesRulesActionCopyObject              R2ConfigurationGetResponseQueuesRulesAction = "CopyObject"
	R2ConfigurationGetResponseQueuesRulesActionDeleteObject            R2ConfigurationGetResponseQueuesRulesAction = "DeleteObject"
	R2ConfigurationGetResponseQueuesRulesActionCompleteMultipartUpload R2ConfigurationGetResponseQueuesRulesAction = "CompleteMultipartUpload"
	R2ConfigurationGetResponseQueuesRulesActionLifecycleDeletion       R2ConfigurationGetResponseQueuesRulesAction = "LifecycleDeletion"
)

func (R2ConfigurationGetResponseQueuesRulesAction) IsKnown added in v3.1.0 

func (r R2ConfigurationGetResponseQueuesRulesAction) IsKnown() bool

type R2ConfigurationQueueDeleteParams 

type R2ConfigurationQueueDeleteParams struct {
	// Account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type R2ConfigurationQueueDeleteResponse added in v3.1.0 

type R2ConfigurationQueueDeleteResponse = interface{}

type R2ConfigurationQueueDeleteResponseEnvelope 

type R2ConfigurationQueueDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo              `json:"errors,required"`
	Messages []string                           `json:"messages,required"`
	Result   R2ConfigurationQueueDeleteResponse `json:"result,required"`
	// Whether the API call was successful
	Success R2ConfigurationQueueDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    r2ConfigurationQueueDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*R2ConfigurationQueueDeleteResponseEnvelope) UnmarshalJSON 

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

type R2ConfigurationQueueDeleteResponseEnvelopeSuccess 

type R2ConfigurationQueueDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	R2ConfigurationQueueDeleteResponseEnvelopeSuccessTrue R2ConfigurationQueueDeleteResponseEnvelopeSuccess = true
)

func (R2ConfigurationQueueDeleteResponseEnvelopeSuccess) IsKnown 

func (r R2ConfigurationQueueDeleteResponseEnvelopeSuccess) IsKnown() bool

type R2ConfigurationQueueService 

type R2ConfigurationQueueService struct {
	Options []option.RequestOption
}

R2ConfigurationQueueService 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 NewR2ConfigurationQueueService method instead.

func NewR2ConfigurationQueueService 

func NewR2ConfigurationQueueService(opts ...option.RequestOption) (r *R2ConfigurationQueueService)

NewR2ConfigurationQueueService 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 (*R2ConfigurationQueueService) Delete 

func (r *R2ConfigurationQueueService) Delete(ctx context.Context, bucketName string, queueID string, body R2ConfigurationQueueDeleteParams, opts ...option.RequestOption) (res *R2ConfigurationQueueDeleteResponse, err error)

Delete an event notification rule. **If no body is provided, all rules for specified queue will be deleted**.

func (*R2ConfigurationQueueService) Update 

func (r *R2ConfigurationQueueService) Update(ctx context.Context, bucketName string, queueID string, params R2ConfigurationQueueUpdateParams, opts ...option.RequestOption) (res *R2ConfigurationQueueUpdateResponse, err error)

Create event notification rule.

type R2ConfigurationQueueUpdateParams 

type R2ConfigurationQueueUpdateParams struct {
	// Account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// Array of rules to drive notifications
	Rules param.Field[[]R2ConfigurationQueueUpdateParamsRule] `json:"rules"`
}

func (R2ConfigurationQueueUpdateParams) MarshalJSON 

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

type R2ConfigurationQueueUpdateParamsRule 

type R2ConfigurationQueueUpdateParamsRule struct {
	// Array of R2 object actions that will trigger notifications
	Actions param.Field[[]R2ConfigurationQueueUpdateParamsRulesAction] `json:"actions,required"`
	// Notifications will be sent only for objects with this prefix
	Prefix param.Field[string] `json:"prefix"`
	// Notifications will be sent only for objects with this suffix
	Suffix param.Field[string] `json:"suffix"`
}

func (R2ConfigurationQueueUpdateParamsRule) MarshalJSON 

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

type R2ConfigurationQueueUpdateParamsRulesAction 

type R2ConfigurationQueueUpdateParamsRulesAction string
const (
	R2ConfigurationQueueUpdateParamsRulesActionPutObject               R2ConfigurationQueueUpdateParamsRulesAction = "PutObject"
	R2ConfigurationQueueUpdateParamsRulesActionCopyObject              R2ConfigurationQueueUpdateParamsRulesAction = "CopyObject"
	R2ConfigurationQueueUpdateParamsRulesActionDeleteObject            R2ConfigurationQueueUpdateParamsRulesAction = "DeleteObject"
	R2ConfigurationQueueUpdateParamsRulesActionCompleteMultipartUpload R2ConfigurationQueueUpdateParamsRulesAction = "CompleteMultipartUpload"
	R2ConfigurationQueueUpdateParamsRulesActionLifecycleDeletion       R2ConfigurationQueueUpdateParamsRulesAction = "LifecycleDeletion"
)

func (R2ConfigurationQueueUpdateParamsRulesAction) IsKnown 

func (r R2ConfigurationQueueUpdateParamsRulesAction) IsKnown() bool

type R2ConfigurationQueueUpdateResponse 

type R2ConfigurationQueueUpdateResponse = interface{}

type R2ConfigurationQueueUpdateResponseEnvelope 

type R2ConfigurationQueueUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo              `json:"errors,required"`
	Messages []string                           `json:"messages,required"`
	Result   R2ConfigurationQueueUpdateResponse `json:"result,required"`
	// Whether the API call was successful
	Success R2ConfigurationQueueUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    r2ConfigurationQueueUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*R2ConfigurationQueueUpdateResponseEnvelope) UnmarshalJSON 

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

type R2ConfigurationQueueUpdateResponseEnvelopeSuccess 

type R2ConfigurationQueueUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	R2ConfigurationQueueUpdateResponseEnvelopeSuccessTrue R2ConfigurationQueueUpdateResponseEnvelopeSuccess = true
)

func (R2ConfigurationQueueUpdateResponseEnvelopeSuccess) IsKnown 

func (r R2ConfigurationQueueUpdateResponseEnvelopeSuccess) IsKnown() bool

type R2ConfigurationService 

type R2ConfigurationService struct {
	Options []option.RequestOption
	Queues  *R2ConfigurationQueueService
}

R2ConfigurationService 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 NewR2ConfigurationService method instead.

func NewR2ConfigurationService 

func NewR2ConfigurationService(opts ...option.RequestOption) (r *R2ConfigurationService)

NewR2ConfigurationService 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 (*R2ConfigurationService) Get 

func (r *R2ConfigurationService) Get(ctx context.Context, bucketName string, query R2ConfigurationGetParams, opts ...option.RequestOption) (res *R2ConfigurationGetResponse, err error)

List all event notification rules for a bucket.

type R2Service 

type R2Service struct {
	Options       []option.RequestOption
	Configuration *R2ConfigurationService
}

R2Service 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 NewR2Service method instead.

func NewR2Service 

func NewR2Service(opts ...option.RequestOption) (r *R2Service)

NewR2Service 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.

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 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.

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.