rum

package
v2.4.0 Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2024 License: Apache-2.0 Imports: 14 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 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.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0 

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 added in v2.2.0 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType added in v2.2.0 

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 added in v2.3.0 

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 MemberParam added in v2.1.0 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

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 RUMRule 

type RUMRule struct {
	// The Web Analytics rule identifier.
	ID      string    `json:"id"`
	Created time.Time `json:"created" format:"date-time"`
	// The hostname the rule will be applied to.
	Host string `json:"host"`
	// Whether the rule includes or excludes traffic from being measured.
	Inclusive bool `json:"inclusive"`
	// Whether the rule is paused or not.
	IsPaused bool `json:"is_paused"`
	// The paths the rule will be applied to.
	Paths    []string    `json:"paths"`
	Priority float64     `json:"priority"`
	JSON     rumRuleJSON `json:"-"`
}

func (*RUMRule) UnmarshalJSON 

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

type RUMService 

type RUMService struct {
	Options  []option.RequestOption
	SiteInfo *SiteInfoService
	Rules    *RuleService
}

RUMService 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 NewRUMService method instead.

func NewRUMService 

func NewRUMService(opts ...option.RequestOption) (r *RUMService)

NewRUMService 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 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 RuleDeleteParams 

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

type RuleDeleteResponse 

type RuleDeleteResponse struct {
	// The Web Analytics rule identifier.
	ID   string                 `json:"id"`
	JSON ruleDeleteResponseJSON `json:"-"`
}

func (*RuleDeleteResponse) UnmarshalJSON 

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

type RuleDeleteResponseEnvelope 

type RuleDeleteResponseEnvelope struct {
	Result RuleDeleteResponse             `json:"result"`
	JSON   ruleDeleteResponseEnvelopeJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelope) UnmarshalJSON 

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

type RuleListParams 

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

type RuleListResponse 

type RuleListResponse struct {
	// A list of rules.
	Rules   []RUMRule               `json:"rules"`
	Ruleset RuleListResponseRuleset `json:"ruleset"`
	JSON    ruleListResponseJSON    `json:"-"`
}

func (*RuleListResponse) UnmarshalJSON 

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

type RuleListResponseEnvelope 

type RuleListResponseEnvelope struct {
	Result RuleListResponse             `json:"result"`
	JSON   ruleListResponseEnvelopeJSON `json:"-"`
}

func (*RuleListResponseEnvelope) UnmarshalJSON 

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

type RuleListResponseRuleset 

type RuleListResponseRuleset struct {
	// The Web Analytics ruleset identifier.
	ID string `json:"id"`
	// Whether the ruleset is enabled.
	Enabled  bool   `json:"enabled"`
	ZoneName string `json:"zone_name"`
	// The zone identifier.
	ZoneTag string                      `json:"zone_tag"`
	JSON    ruleListResponseRulesetJSON `json:"-"`
}

func (*RuleListResponseRuleset) UnmarshalJSON 

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

type RuleNewParams 

type RuleNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Host      param.Field[string] `json:"host"`
	// Whether the rule includes or excludes traffic from being measured.
	Inclusive param.Field[bool] `json:"inclusive"`
	// Whether the rule is paused or not.
	IsPaused param.Field[bool]     `json:"is_paused"`
	Paths    param.Field[[]string] `json:"paths"`
}

func (RuleNewParams) MarshalJSON 

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

type RuleNewResponseEnvelope 

type RuleNewResponseEnvelope struct {
	Result RUMRule                     `json:"result"`
	JSON   ruleNewResponseEnvelopeJSON `json:"-"`
}

func (*RuleNewResponseEnvelope) UnmarshalJSON 

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

type RuleService 

type RuleService struct {
	Options []option.RequestOption
}

RuleService 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 NewRuleService method instead.

func NewRuleService 

func NewRuleService(opts ...option.RequestOption) (r *RuleService)

NewRuleService 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 (*RuleService) Delete 

func (r *RuleService) Delete(ctx context.Context, rulesetID string, ruleID string, body RuleDeleteParams, opts ...option.RequestOption) (res *RuleDeleteResponse, err error)

Deletes an existing rule from a Web Analytics ruleset.

func (*RuleService) List 

func (r *RuleService) List(ctx context.Context, rulesetID string, query RuleListParams, opts ...option.RequestOption) (res *RuleListResponse, err error)

Lists all the rules in a Web Analytics ruleset.

func (*RuleService) New 

func (r *RuleService) New(ctx context.Context, rulesetID string, params RuleNewParams, opts ...option.RequestOption) (res *RUMRule, err error)

Creates a new rule in a Web Analytics ruleset.

func (*RuleService) Update 

func (r *RuleService) Update(ctx context.Context, rulesetID string, ruleID string, params RuleUpdateParams, opts ...option.RequestOption) (res *RUMRule, err error)

Updates a rule in a Web Analytics ruleset.

type RuleUpdateParams 

type RuleUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Host      param.Field[string] `json:"host"`
	// Whether the rule includes or excludes traffic from being measured.
	Inclusive param.Field[bool] `json:"inclusive"`
	// Whether the rule is paused or not.
	IsPaused param.Field[bool]     `json:"is_paused"`
	Paths    param.Field[[]string] `json:"paths"`
}

func (RuleUpdateParams) MarshalJSON 

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

type RuleUpdateResponseEnvelope 

type RuleUpdateResponseEnvelope struct {
	Result RUMRule                        `json:"result"`
	JSON   ruleUpdateResponseEnvelopeJSON `json:"-"`
}

func (*RuleUpdateResponseEnvelope) UnmarshalJSON 

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

type Site 

type Site struct {
	// If enabled, the JavaScript snippet is automatically injected for orange-clouded
	// sites.
	AutoInstall bool      `json:"auto_install"`
	Created     time.Time `json:"created" format:"date-time"`
	// A list of rules.
	Rules   []RUMRule   `json:"rules"`
	Ruleset SiteRuleset `json:"ruleset"`
	// The Web Analytics site identifier.
	SiteTag string `json:"site_tag"`
	// The Web Analytics site token.
	SiteToken string `json:"site_token"`
	// Encoded JavaScript snippet.
	Snippet string   `json:"snippet"`
	JSON    siteJSON `json:"-"`
}

func (*Site) UnmarshalJSON 

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

type SiteInfoDeleteParams 

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

type SiteInfoDeleteResponse 

type SiteInfoDeleteResponse struct {
	// The Web Analytics site identifier.
	SiteTag string                     `json:"site_tag"`
	JSON    siteInfoDeleteResponseJSON `json:"-"`
}

func (*SiteInfoDeleteResponse) UnmarshalJSON 

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

type SiteInfoDeleteResponseEnvelope 

type SiteInfoDeleteResponseEnvelope struct {
	Result SiteInfoDeleteResponse             `json:"result"`
	JSON   siteInfoDeleteResponseEnvelopeJSON `json:"-"`
}

func (*SiteInfoDeleteResponseEnvelope) UnmarshalJSON 

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

type SiteInfoGetParams 

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

type SiteInfoGetResponseEnvelope 

type SiteInfoGetResponseEnvelope struct {
	Result Site                            `json:"result"`
	JSON   siteInfoGetResponseEnvelopeJSON `json:"-"`
}

func (*SiteInfoGetResponseEnvelope) UnmarshalJSON 

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

type SiteInfoListParams 

type SiteInfoListParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The property used to sort the list of results.
	OrderBy param.Field[SiteInfoListParamsOrderBy] `query:"order_by"`
	// Current page within the paginated list of results.
	Page param.Field[float64] `query:"page"`
	// Number of items to return per page of results.
	PerPage param.Field[float64] `query:"per_page"`
}

func (SiteInfoListParams) URLQuery 

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

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

type SiteInfoListParamsOrderBy 

type SiteInfoListParamsOrderBy string

The property used to sort the list of results. 

const (
	SiteInfoListParamsOrderByHost    SiteInfoListParamsOrderBy = "host"
	SiteInfoListParamsOrderByCreated SiteInfoListParamsOrderBy = "created"
)

func (SiteInfoListParamsOrderBy) IsKnown 

func (r SiteInfoListParamsOrderBy) IsKnown() bool

type SiteInfoNewParams 

type SiteInfoNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// If enabled, the JavaScript snippet is automatically injected for orange-clouded
	// sites.
	AutoInstall param.Field[bool] `json:"auto_install"`
	// The hostname to use for gray-clouded sites.
	Host param.Field[string] `json:"host"`
	// The zone identifier.
	ZoneTag param.Field[string] `json:"zone_tag"`
}

func (SiteInfoNewParams) MarshalJSON 

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

type SiteInfoNewResponseEnvelope 

type SiteInfoNewResponseEnvelope struct {
	Result Site                            `json:"result"`
	JSON   siteInfoNewResponseEnvelopeJSON `json:"-"`
}

func (*SiteInfoNewResponseEnvelope) UnmarshalJSON 

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

type SiteInfoService 

type SiteInfoService struct {
	Options []option.RequestOption
}

SiteInfoService 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 NewSiteInfoService method instead.

func NewSiteInfoService 

func NewSiteInfoService(opts ...option.RequestOption) (r *SiteInfoService)

NewSiteInfoService 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 (*SiteInfoService) Delete 

func (r *SiteInfoService) Delete(ctx context.Context, siteID string, body SiteInfoDeleteParams, opts ...option.RequestOption) (res *SiteInfoDeleteResponse, err error)

Deletes an existing Web Analytics site.

func (*SiteInfoService) Get 

func (r *SiteInfoService) Get(ctx context.Context, siteID string, query SiteInfoGetParams, opts ...option.RequestOption) (res *Site, err error)

Retrieves a Web Analytics site.

func (*SiteInfoService) List 

func (r *SiteInfoService) List(ctx context.Context, params SiteInfoListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[Site], err error)

Lists all Web Analytics sites of an account.

func (*SiteInfoService) ListAutoPaging 

func (r *SiteInfoService) ListAutoPaging(ctx context.Context, params SiteInfoListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[Site]

Lists all Web Analytics sites of an account.

func (*SiteInfoService) New 

func (r *SiteInfoService) New(ctx context.Context, params SiteInfoNewParams, opts ...option.RequestOption) (res *Site, err error)

Creates a new Web Analytics site.

func (*SiteInfoService) Update 

func (r *SiteInfoService) Update(ctx context.Context, siteID string, params SiteInfoUpdateParams, opts ...option.RequestOption) (res *Site, err error)

Updates an existing Web Analytics site.

type SiteInfoUpdateParams 

type SiteInfoUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// If enabled, the JavaScript snippet is automatically injected for orange-clouded
	// sites.
	AutoInstall param.Field[bool] `json:"auto_install"`
	// The hostname to use for gray-clouded sites.
	Host param.Field[string] `json:"host"`
	// The zone identifier.
	ZoneTag param.Field[string] `json:"zone_tag"`
}

func (SiteInfoUpdateParams) MarshalJSON 

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

type SiteInfoUpdateResponseEnvelope 

type SiteInfoUpdateResponseEnvelope struct {
	Result Site                               `json:"result"`
	JSON   siteInfoUpdateResponseEnvelopeJSON `json:"-"`
}

func (*SiteInfoUpdateResponseEnvelope) UnmarshalJSON 

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

type SiteRuleset 

type SiteRuleset struct {
	// The Web Analytics ruleset identifier.
	ID string `json:"id"`
	// Whether the ruleset is enabled.
	Enabled  bool   `json:"enabled"`
	ZoneName string `json:"zone_name"`
	// The zone identifier.
	ZoneTag string          `json:"zone_tag"`
	JSON    siteRulesetJSON `json:"-"`
}

func (*SiteRuleset) UnmarshalJSON 

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

type SortDirection added in v2.2.0 

type SortDirection = shared.SortDirection

Direction to order DNS records 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.