Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type BrowserRenderingService
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type ContentNewParams
- type ContentNewParamsBody
- type ContentNewParamsBodyObject
- type ContentNewParamsBodyObjectAddScriptTag
- type ContentNewParamsBodyObjectAddStyleTag
- type ContentNewParamsBodyObjectAllowResourceType
- type ContentNewParamsBodyObjectAuthenticate
- type ContentNewParamsBodyObjectCookie
- type ContentNewParamsBodyObjectCookiesPriority
- type ContentNewParamsBodyObjectCookiesSameSite
- type ContentNewParamsBodyObjectCookiesSourceScheme
- type ContentNewParamsBodyObjectGotoOptions
- type ContentNewParamsBodyObjectGotoOptionsWaitUntilArray
- type ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type ContentNewParamsBodyObjectGotoOptionsWaitUntilString
- type ContentNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type ContentNewParamsBodyObjectRejectResourceType
- type ContentNewParamsBodyObjectViewport
- type ContentNewParamsBodyObjectWaitForSelector
- type ContentNewParamsBodyObjectWaitForSelectorHidden
- type ContentNewParamsBodyObjectWaitForSelectorVisible
- type ContentNewParamsBodyUnion
- type ContentNewResponseEnvelope
- type ContentNewResponseEnvelopeErrors
- type ContentNewResponseEnvelopeMeta
- type ContentService
- type Error
- type ErrorData
- type ErrorDataSource
- type JsonNewParams
- type JsonNewParamsBody
- type JsonNewParamsBodyObject
- type JsonNewParamsBodyObjectAddScriptTag
- type JsonNewParamsBodyObjectAddStyleTag
- type JsonNewParamsBodyObjectAllowResourceType
- type JsonNewParamsBodyObjectAuthenticate
- type JsonNewParamsBodyObjectCookie
- type JsonNewParamsBodyObjectCookiesPriority
- type JsonNewParamsBodyObjectCookiesSameSite
- type JsonNewParamsBodyObjectCookiesSourceScheme
- type JsonNewParamsBodyObjectCustomAI
- type JsonNewParamsBodyObjectGotoOptions
- type JsonNewParamsBodyObjectGotoOptionsWaitUntilArray
- type JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type JsonNewParamsBodyObjectGotoOptionsWaitUntilString
- type JsonNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type JsonNewParamsBodyObjectRejectResourceType
- type JsonNewParamsBodyObjectResponseFormat
- type JsonNewParamsBodyObjectResponseFormatJsonSchemaArray
- type JsonNewParamsBodyObjectResponseFormatJsonSchemaUnion
- type JsonNewParamsBodyObjectViewport
- type JsonNewParamsBodyObjectWaitForSelector
- type JsonNewParamsBodyObjectWaitForSelectorHidden
- type JsonNewParamsBodyObjectWaitForSelectorVisible
- type JsonNewParamsBodyUnion
- type JsonNewResponse
- type JsonNewResponseEnvelope
- type JsonNewResponseEnvelopeErrors
- type JsonService
- type LinkNewParams
- type LinkNewParamsBody
- type LinkNewParamsBodyObject
- type LinkNewParamsBodyObjectAddScriptTag
- type LinkNewParamsBodyObjectAddStyleTag
- type LinkNewParamsBodyObjectAllowResourceType
- type LinkNewParamsBodyObjectAuthenticate
- type LinkNewParamsBodyObjectCookie
- type LinkNewParamsBodyObjectCookiesPriority
- type LinkNewParamsBodyObjectCookiesSameSite
- type LinkNewParamsBodyObjectCookiesSourceScheme
- type LinkNewParamsBodyObjectGotoOptions
- type LinkNewParamsBodyObjectGotoOptionsWaitUntilArray
- type LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type LinkNewParamsBodyObjectGotoOptionsWaitUntilString
- type LinkNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type LinkNewParamsBodyObjectRejectResourceType
- type LinkNewParamsBodyObjectViewport
- type LinkNewParamsBodyObjectWaitForSelector
- type LinkNewParamsBodyObjectWaitForSelectorHidden
- type LinkNewParamsBodyObjectWaitForSelectorVisible
- type LinkNewParamsBodyUnion
- type LinkNewResponseEnvelope
- type LinkNewResponseEnvelopeErrors
- type LinkService
- type MarkdownNewParams
- type MarkdownNewParamsBody
- type MarkdownNewParamsBodyObject
- type MarkdownNewParamsBodyObjectAddScriptTag
- type MarkdownNewParamsBodyObjectAddStyleTag
- type MarkdownNewParamsBodyObjectAllowResourceType
- type MarkdownNewParamsBodyObjectAuthenticate
- type MarkdownNewParamsBodyObjectCookie
- type MarkdownNewParamsBodyObjectCookiesPriority
- type MarkdownNewParamsBodyObjectCookiesSameSite
- type MarkdownNewParamsBodyObjectCookiesSourceScheme
- type MarkdownNewParamsBodyObjectGotoOptions
- type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArray
- type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString
- type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type MarkdownNewParamsBodyObjectRejectResourceType
- type MarkdownNewParamsBodyObjectViewport
- type MarkdownNewParamsBodyObjectWaitForSelector
- type MarkdownNewParamsBodyObjectWaitForSelectorHidden
- type MarkdownNewParamsBodyObjectWaitForSelectorVisible
- type MarkdownNewParamsBodyUnion
- type MarkdownNewResponseEnvelope
- type MarkdownNewResponseEnvelopeErrors
- type MarkdownService
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type PDFNewParams
- type PDFNewParamsBody
- type PDFNewParamsBodyObject
- type PDFNewParamsBodyObjectAddScriptTag
- type PDFNewParamsBodyObjectAddStyleTag
- type PDFNewParamsBodyObjectAllowResourceType
- type PDFNewParamsBodyObjectAuthenticate
- type PDFNewParamsBodyObjectCookie
- type PDFNewParamsBodyObjectCookiesPriority
- type PDFNewParamsBodyObjectCookiesSameSite
- type PDFNewParamsBodyObjectCookiesSourceScheme
- type PDFNewParamsBodyObjectGotoOptions
- type PDFNewParamsBodyObjectGotoOptionsWaitUntilArray
- type PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type PDFNewParamsBodyObjectGotoOptionsWaitUntilString
- type PDFNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type PDFNewParamsBodyObjectPDFOptions
- type PDFNewParamsBodyObjectPDFOptionsFormat
- type PDFNewParamsBodyObjectPDFOptionsHeightUnion
- type PDFNewParamsBodyObjectPDFOptionsMargin
- type PDFNewParamsBodyObjectPDFOptionsMarginBottomUnion
- type PDFNewParamsBodyObjectPDFOptionsMarginLeftUnion
- type PDFNewParamsBodyObjectPDFOptionsMarginRightUnion
- type PDFNewParamsBodyObjectPDFOptionsMarginTopUnion
- type PDFNewParamsBodyObjectPDFOptionsWidthUnion
- type PDFNewParamsBodyObjectRejectResourceType
- type PDFNewParamsBodyObjectViewport
- type PDFNewParamsBodyObjectWaitForSelector
- type PDFNewParamsBodyObjectWaitForSelectorHidden
- type PDFNewParamsBodyObjectWaitForSelectorVisible
- type PDFNewParamsBodyUnion
- type PDFService
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type ScrapeNewParams
- type ScrapeNewParamsBody
- type ScrapeNewParamsBodyObject
- type ScrapeNewParamsBodyObjectAddScriptTag
- type ScrapeNewParamsBodyObjectAddStyleTag
- type ScrapeNewParamsBodyObjectAllowResourceType
- type ScrapeNewParamsBodyObjectAuthenticate
- type ScrapeNewParamsBodyObjectCookie
- type ScrapeNewParamsBodyObjectCookiesPriority
- type ScrapeNewParamsBodyObjectCookiesSameSite
- type ScrapeNewParamsBodyObjectCookiesSourceScheme
- type ScrapeNewParamsBodyObjectElement
- type ScrapeNewParamsBodyObjectGotoOptions
- type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArray
- type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString
- type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type ScrapeNewParamsBodyObjectRejectResourceType
- type ScrapeNewParamsBodyObjectViewport
- type ScrapeNewParamsBodyObjectWaitForSelector
- type ScrapeNewParamsBodyObjectWaitForSelectorHidden
- type ScrapeNewParamsBodyObjectWaitForSelectorVisible
- type ScrapeNewParamsBodyUnion
- type ScrapeNewResponse
- type ScrapeNewResponseEnvelope
- type ScrapeNewResponseEnvelopeErrors
- type ScrapeNewResponseResults
- type ScrapeNewResponseResultsAttribute
- type ScrapeService
- type ScreenshotNewParams
- type ScreenshotNewParamsBody
- type ScreenshotNewParamsBodyObject
- type ScreenshotNewParamsBodyObjectAddScriptTag
- type ScreenshotNewParamsBodyObjectAddStyleTag
- type ScreenshotNewParamsBodyObjectAllowResourceType
- type ScreenshotNewParamsBodyObjectAuthenticate
- type ScreenshotNewParamsBodyObjectCookie
- type ScreenshotNewParamsBodyObjectCookiesPriority
- type ScreenshotNewParamsBodyObjectCookiesSameSite
- type ScreenshotNewParamsBodyObjectCookiesSourceScheme
- type ScreenshotNewParamsBodyObjectGotoOptions
- type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArray
- type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString
- type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type ScreenshotNewParamsBodyObjectRejectResourceType
- type ScreenshotNewParamsBodyObjectScreenshotOptions
- type ScreenshotNewParamsBodyObjectScreenshotOptionsClip
- type ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding
- type ScreenshotNewParamsBodyObjectScreenshotOptionsType
- type ScreenshotNewParamsBodyObjectViewport
- type ScreenshotNewParamsBodyObjectWaitForSelector
- type ScreenshotNewParamsBodyObjectWaitForSelectorHidden
- type ScreenshotNewParamsBodyObjectWaitForSelectorVisible
- type ScreenshotNewParamsBodyUnion
- type ScreenshotNewResponse
- type ScreenshotNewResponseError
- type ScreenshotService
- type SnapshotNewParams
- type SnapshotNewParamsBody
- type SnapshotNewParamsBodyObject
- type SnapshotNewParamsBodyObjectAddScriptTag
- type SnapshotNewParamsBodyObjectAddStyleTag
- type SnapshotNewParamsBodyObjectAllowResourceType
- type SnapshotNewParamsBodyObjectAuthenticate
- type SnapshotNewParamsBodyObjectCookie
- type SnapshotNewParamsBodyObjectCookiesPriority
- type SnapshotNewParamsBodyObjectCookiesSameSite
- type SnapshotNewParamsBodyObjectCookiesSourceScheme
- type SnapshotNewParamsBodyObjectGotoOptions
- type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArray
- type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
- type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString
- type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilUnion
- type SnapshotNewParamsBodyObjectRejectResourceType
- type SnapshotNewParamsBodyObjectScreenshotOptions
- type SnapshotNewParamsBodyObjectScreenshotOptionsClip
- type SnapshotNewParamsBodyObjectScreenshotOptionsType
- type SnapshotNewParamsBodyObjectViewport
- type SnapshotNewParamsBodyObjectWaitForSelector
- type SnapshotNewParamsBodyObjectWaitForSelectorHidden
- type SnapshotNewParamsBodyObjectWaitForSelectorVisible
- type SnapshotNewParamsBodyUnion
- type SnapshotNewResponse
- type SnapshotNewResponseEnvelope
- type SnapshotNewResponseEnvelopeErrors
- type SnapshotNewResponseEnvelopeMeta
- type SnapshotService
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 BrowserRenderingService ¶
type BrowserRenderingService struct {
Options []option.RequestOption
Content *ContentService
PDF *PDFService
Scrape *ScrapeService
Screenshot *ScreenshotService
Snapshot *SnapshotService
Json *JsonService
Links *LinkService
Markdown *MarkdownService
}
BrowserRenderingService 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 NewBrowserRenderingService method instead.
func NewBrowserRenderingService ¶
func NewBrowserRenderingService(opts ...option.RequestOption) (r *BrowserRenderingService)
NewBrowserRenderingService 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 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 CloudflareTunnelConfigSrc ¶
type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc
Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
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 ContentNewParams ¶
type ContentNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body ContentNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (ContentNewParams) MarshalJSON ¶
func (r ContentNewParams) MarshalJSON() (data []byte, err error)
func (ContentNewParams) URLQuery ¶
func (r ContentNewParams) URLQuery() (v url.Values)
URLQuery serializes ContentNewParams's query parameters as `url.Values`.
type ContentNewParamsBody ¶ added in v6.6.0
type ContentNewParamsBody struct {
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (ContentNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBody) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObject ¶ added in v6.6.0
type ContentNewParamsBodyObject struct {
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url,required" format:"uri"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]ContentNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]ContentNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]ContentNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[ContentNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]ContentNewParamsBodyObjectCookie] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[ContentNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]ContentNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[ContentNewParamsBodyObjectViewport] `json:"viewport"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[ContentNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (ContentNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type ContentNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (ContentNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type ContentNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (ContentNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type ContentNewParamsBodyObjectAllowResourceType string
const ( ContentNewParamsBodyObjectAllowResourceTypeDocument ContentNewParamsBodyObjectAllowResourceType = "document" ContentNewParamsBodyObjectAllowResourceTypeStylesheet ContentNewParamsBodyObjectAllowResourceType = "stylesheet" ContentNewParamsBodyObjectAllowResourceTypeImage ContentNewParamsBodyObjectAllowResourceType = "image" ContentNewParamsBodyObjectAllowResourceTypeMedia ContentNewParamsBodyObjectAllowResourceType = "media" ContentNewParamsBodyObjectAllowResourceTypeFont ContentNewParamsBodyObjectAllowResourceType = "font" ContentNewParamsBodyObjectAllowResourceTypeScript ContentNewParamsBodyObjectAllowResourceType = "script" ContentNewParamsBodyObjectAllowResourceTypeTexttrack ContentNewParamsBodyObjectAllowResourceType = "texttrack" ContentNewParamsBodyObjectAllowResourceTypeXHR ContentNewParamsBodyObjectAllowResourceType = "xhr" ContentNewParamsBodyObjectAllowResourceTypeFetch ContentNewParamsBodyObjectAllowResourceType = "fetch" ContentNewParamsBodyObjectAllowResourceTypePrefetch ContentNewParamsBodyObjectAllowResourceType = "prefetch" ContentNewParamsBodyObjectAllowResourceTypeEventsource ContentNewParamsBodyObjectAllowResourceType = "eventsource" ContentNewParamsBodyObjectAllowResourceTypeWebsocket ContentNewParamsBodyObjectAllowResourceType = "websocket" ContentNewParamsBodyObjectAllowResourceTypeManifest ContentNewParamsBodyObjectAllowResourceType = "manifest" ContentNewParamsBodyObjectAllowResourceTypeSignedexchange ContentNewParamsBodyObjectAllowResourceType = "signedexchange" ContentNewParamsBodyObjectAllowResourceTypePing ContentNewParamsBodyObjectAllowResourceType = "ping" ContentNewParamsBodyObjectAllowResourceTypeCspviolationreport ContentNewParamsBodyObjectAllowResourceType = "cspviolationreport" ContentNewParamsBodyObjectAllowResourceTypePreflight ContentNewParamsBodyObjectAllowResourceType = "preflight" ContentNewParamsBodyObjectAllowResourceTypeOther ContentNewParamsBodyObjectAllowResourceType = "other" )
func (ContentNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectAllowResourceType) IsKnown() bool
type ContentNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type ContentNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (ContentNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectCookie ¶ added in v6.6.0
type ContentNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[ContentNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[ContentNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[ContentNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (ContentNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type ContentNewParamsBodyObjectCookiesPriority string
const ( ContentNewParamsBodyObjectCookiesPriorityLow ContentNewParamsBodyObjectCookiesPriority = "Low" ContentNewParamsBodyObjectCookiesPriorityMedium ContentNewParamsBodyObjectCookiesPriority = "Medium" ContentNewParamsBodyObjectCookiesPriorityHigh ContentNewParamsBodyObjectCookiesPriority = "High" )
func (ContentNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectCookiesPriority) IsKnown() bool
type ContentNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type ContentNewParamsBodyObjectCookiesSameSite string
const ( ContentNewParamsBodyObjectCookiesSameSiteStrict ContentNewParamsBodyObjectCookiesSameSite = "Strict" ContentNewParamsBodyObjectCookiesSameSiteLax ContentNewParamsBodyObjectCookiesSameSite = "Lax" ContentNewParamsBodyObjectCookiesSameSiteNone ContentNewParamsBodyObjectCookiesSameSite = "None" )
func (ContentNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type ContentNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type ContentNewParamsBodyObjectCookiesSourceScheme string
const ( ContentNewParamsBodyObjectCookiesSourceSchemeUnset ContentNewParamsBodyObjectCookiesSourceScheme = "Unset" ContentNewParamsBodyObjectCookiesSourceSchemeNonSecure ContentNewParamsBodyObjectCookiesSourceScheme = "NonSecure" ContentNewParamsBodyObjectCookiesSourceSchemeSecure ContentNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (ContentNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type ContentNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type ContentNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[ContentNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (ContentNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type ContentNewParamsBodyObjectGotoOptionsWaitUntilArray []ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type ContentNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type ContentNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( ContentNewParamsBodyObjectGotoOptionsWaitUntilStringLoad ContentNewParamsBodyObjectGotoOptionsWaitUntilString = "load" ContentNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded ContentNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" ContentNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 ContentNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" ContentNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 ContentNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (ContentNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type ContentNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type ContentNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.ContentNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.ContentNewParamsBodyObjectGotoOptionsWaitUntilArray.
type ContentNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type ContentNewParamsBodyObjectRejectResourceType string
const ( ContentNewParamsBodyObjectRejectResourceTypeDocument ContentNewParamsBodyObjectRejectResourceType = "document" ContentNewParamsBodyObjectRejectResourceTypeStylesheet ContentNewParamsBodyObjectRejectResourceType = "stylesheet" ContentNewParamsBodyObjectRejectResourceTypeImage ContentNewParamsBodyObjectRejectResourceType = "image" ContentNewParamsBodyObjectRejectResourceTypeMedia ContentNewParamsBodyObjectRejectResourceType = "media" ContentNewParamsBodyObjectRejectResourceTypeFont ContentNewParamsBodyObjectRejectResourceType = "font" ContentNewParamsBodyObjectRejectResourceTypeScript ContentNewParamsBodyObjectRejectResourceType = "script" ContentNewParamsBodyObjectRejectResourceTypeTexttrack ContentNewParamsBodyObjectRejectResourceType = "texttrack" ContentNewParamsBodyObjectRejectResourceTypeXHR ContentNewParamsBodyObjectRejectResourceType = "xhr" ContentNewParamsBodyObjectRejectResourceTypeFetch ContentNewParamsBodyObjectRejectResourceType = "fetch" ContentNewParamsBodyObjectRejectResourceTypePrefetch ContentNewParamsBodyObjectRejectResourceType = "prefetch" ContentNewParamsBodyObjectRejectResourceTypeEventsource ContentNewParamsBodyObjectRejectResourceType = "eventsource" ContentNewParamsBodyObjectRejectResourceTypeWebsocket ContentNewParamsBodyObjectRejectResourceType = "websocket" ContentNewParamsBodyObjectRejectResourceTypeManifest ContentNewParamsBodyObjectRejectResourceType = "manifest" ContentNewParamsBodyObjectRejectResourceTypeSignedexchange ContentNewParamsBodyObjectRejectResourceType = "signedexchange" ContentNewParamsBodyObjectRejectResourceTypePing ContentNewParamsBodyObjectRejectResourceType = "ping" ContentNewParamsBodyObjectRejectResourceTypeCspviolationreport ContentNewParamsBodyObjectRejectResourceType = "cspviolationreport" ContentNewParamsBodyObjectRejectResourceTypePreflight ContentNewParamsBodyObjectRejectResourceType = "preflight" ContentNewParamsBodyObjectRejectResourceTypeOther ContentNewParamsBodyObjectRejectResourceType = "other" )
func (ContentNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectRejectResourceType) IsKnown() bool
type ContentNewParamsBodyObjectViewport ¶ added in v6.6.0
type ContentNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (ContentNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type ContentNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[ContentNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[ContentNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (ContentNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type ContentNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type ContentNewParamsBodyObjectWaitForSelectorHidden bool
const (
ContentNewParamsBodyObjectWaitForSelectorHiddenTrue ContentNewParamsBodyObjectWaitForSelectorHidden = true
)
func (ContentNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type ContentNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type ContentNewParamsBodyObjectWaitForSelectorVisible bool
const (
ContentNewParamsBodyObjectWaitForSelectorVisibleTrue ContentNewParamsBodyObjectWaitForSelectorVisible = true
)
func (ContentNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r ContentNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type ContentNewParamsBodyUnion ¶ added in v6.6.0
type ContentNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.ContentNewParamsBodyObject, browser_rendering.ContentNewParamsBodyObject, ContentNewParamsBody.
type ContentNewResponseEnvelope ¶
type ContentNewResponseEnvelope struct {
Meta ContentNewResponseEnvelopeMeta `json:"meta,required"`
// Response status
Success bool `json:"success,required"`
Errors []ContentNewResponseEnvelopeErrors `json:"errors"`
// HTML content
Result string `json:"result"`
JSON contentNewResponseEnvelopeJSON `json:"-"`
}
func (*ContentNewResponseEnvelope) UnmarshalJSON ¶
func (r *ContentNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ContentNewResponseEnvelopeErrors ¶
type ContentNewResponseEnvelopeErrors struct {
// Error code
Code float64 `json:"code,required"`
// Error Message
Message string `json:"message,required"`
JSON contentNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ContentNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ContentNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ContentNewResponseEnvelopeMeta ¶
type ContentNewResponseEnvelopeMeta struct {
Status float64 `json:"status"`
Title string `json:"title"`
JSON contentNewResponseEnvelopeMetaJSON `json:"-"`
}
func (*ContentNewResponseEnvelopeMeta) UnmarshalJSON ¶
func (r *ContentNewResponseEnvelopeMeta) UnmarshalJSON(data []byte) (err error)
type ContentService ¶
type ContentService struct {
Options []option.RequestOption
}
ContentService 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 NewContentService method instead.
func NewContentService ¶
func NewContentService(opts ...option.RequestOption) (r *ContentService)
NewContentService 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 (*ContentService) New ¶
func (r *ContentService) New(ctx context.Context, params ContentNewParams, opts ...option.RequestOption) (res *string, err error)
Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type JsonNewParams ¶
type JsonNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body JsonNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (JsonNewParams) MarshalJSON ¶
func (r JsonNewParams) MarshalJSON() (data []byte, err error)
func (JsonNewParams) URLQuery ¶
func (r JsonNewParams) URLQuery() (v url.Values)
URLQuery serializes JsonNewParams's query parameters as `url.Values`.
type JsonNewParamsBody ¶ added in v6.6.0
type JsonNewParamsBody struct {
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
CustomAI param.Field[interface{}] `json:"custom_ai"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
Prompt param.Field[string] `json:"prompt"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
ResponseFormat param.Field[interface{}] `json:"response_format"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (JsonNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBody) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObject ¶ added in v6.6.0
type JsonNewParamsBodyObject struct {
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html,required"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]JsonNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]JsonNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]JsonNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[JsonNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]JsonNewParamsBodyObjectCookie] `json:"cookies"`
// Optional list of custom AI models to use for the request. The models will be
// tried in the order provided, and in case a model returns an error, the next one
// will be used as fallback.
CustomAI param.Field[[]JsonNewParamsBodyObjectCustomAI] `json:"custom_ai"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[JsonNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
Prompt param.Field[string] `json:"prompt"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]JsonNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
ResponseFormat param.Field[JsonNewParamsBodyObjectResponseFormat] `json:"response_format"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[JsonNewParamsBodyObjectViewport] `json:"viewport"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[JsonNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (JsonNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type JsonNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (JsonNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type JsonNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (JsonNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type JsonNewParamsBodyObjectAllowResourceType string
const ( JsonNewParamsBodyObjectAllowResourceTypeDocument JsonNewParamsBodyObjectAllowResourceType = "document" JsonNewParamsBodyObjectAllowResourceTypeStylesheet JsonNewParamsBodyObjectAllowResourceType = "stylesheet" JsonNewParamsBodyObjectAllowResourceTypeImage JsonNewParamsBodyObjectAllowResourceType = "image" JsonNewParamsBodyObjectAllowResourceTypeMedia JsonNewParamsBodyObjectAllowResourceType = "media" JsonNewParamsBodyObjectAllowResourceTypeFont JsonNewParamsBodyObjectAllowResourceType = "font" JsonNewParamsBodyObjectAllowResourceTypeScript JsonNewParamsBodyObjectAllowResourceType = "script" JsonNewParamsBodyObjectAllowResourceTypeTexttrack JsonNewParamsBodyObjectAllowResourceType = "texttrack" JsonNewParamsBodyObjectAllowResourceTypeXHR JsonNewParamsBodyObjectAllowResourceType = "xhr" JsonNewParamsBodyObjectAllowResourceTypeFetch JsonNewParamsBodyObjectAllowResourceType = "fetch" JsonNewParamsBodyObjectAllowResourceTypePrefetch JsonNewParamsBodyObjectAllowResourceType = "prefetch" JsonNewParamsBodyObjectAllowResourceTypeEventsource JsonNewParamsBodyObjectAllowResourceType = "eventsource" JsonNewParamsBodyObjectAllowResourceTypeWebsocket JsonNewParamsBodyObjectAllowResourceType = "websocket" JsonNewParamsBodyObjectAllowResourceTypeManifest JsonNewParamsBodyObjectAllowResourceType = "manifest" JsonNewParamsBodyObjectAllowResourceTypeSignedexchange JsonNewParamsBodyObjectAllowResourceType = "signedexchange" JsonNewParamsBodyObjectAllowResourceTypePing JsonNewParamsBodyObjectAllowResourceType = "ping" JsonNewParamsBodyObjectAllowResourceTypeCspviolationreport JsonNewParamsBodyObjectAllowResourceType = "cspviolationreport" JsonNewParamsBodyObjectAllowResourceTypePreflight JsonNewParamsBodyObjectAllowResourceType = "preflight" JsonNewParamsBodyObjectAllowResourceTypeOther JsonNewParamsBodyObjectAllowResourceType = "other" )
func (JsonNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectAllowResourceType) IsKnown() bool
type JsonNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type JsonNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (JsonNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectCookie ¶ added in v6.6.0
type JsonNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[JsonNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[JsonNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[JsonNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (JsonNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type JsonNewParamsBodyObjectCookiesPriority string
const ( JsonNewParamsBodyObjectCookiesPriorityLow JsonNewParamsBodyObjectCookiesPriority = "Low" JsonNewParamsBodyObjectCookiesPriorityMedium JsonNewParamsBodyObjectCookiesPriority = "Medium" JsonNewParamsBodyObjectCookiesPriorityHigh JsonNewParamsBodyObjectCookiesPriority = "High" )
func (JsonNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectCookiesPriority) IsKnown() bool
type JsonNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type JsonNewParamsBodyObjectCookiesSameSite string
const ( JsonNewParamsBodyObjectCookiesSameSiteStrict JsonNewParamsBodyObjectCookiesSameSite = "Strict" JsonNewParamsBodyObjectCookiesSameSiteLax JsonNewParamsBodyObjectCookiesSameSite = "Lax" JsonNewParamsBodyObjectCookiesSameSiteNone JsonNewParamsBodyObjectCookiesSameSite = "None" )
func (JsonNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type JsonNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type JsonNewParamsBodyObjectCookiesSourceScheme string
const ( JsonNewParamsBodyObjectCookiesSourceSchemeUnset JsonNewParamsBodyObjectCookiesSourceScheme = "Unset" JsonNewParamsBodyObjectCookiesSourceSchemeNonSecure JsonNewParamsBodyObjectCookiesSourceScheme = "NonSecure" JsonNewParamsBodyObjectCookiesSourceSchemeSecure JsonNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (JsonNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type JsonNewParamsBodyObjectCustomAI ¶ added in v6.6.0
type JsonNewParamsBodyObjectCustomAI struct {
// Authorization token for the AI model: `Bearer <token>`.
Authorization param.Field[string] `json:"authorization,required"`
// AI model to use for the request. Must be formed as `<provider>/<model_name>`,
// e.g. `workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast`
Model param.Field[string] `json:"model,required"`
}
func (JsonNewParamsBodyObjectCustomAI) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectCustomAI) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type JsonNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[JsonNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (JsonNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type JsonNewParamsBodyObjectGotoOptionsWaitUntilArray []JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type JsonNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type JsonNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( JsonNewParamsBodyObjectGotoOptionsWaitUntilStringLoad JsonNewParamsBodyObjectGotoOptionsWaitUntilString = "load" JsonNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded JsonNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" JsonNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 JsonNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" JsonNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 JsonNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (JsonNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type JsonNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type JsonNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.JsonNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.JsonNewParamsBodyObjectGotoOptionsWaitUntilArray.
type JsonNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type JsonNewParamsBodyObjectRejectResourceType string
const ( JsonNewParamsBodyObjectRejectResourceTypeDocument JsonNewParamsBodyObjectRejectResourceType = "document" JsonNewParamsBodyObjectRejectResourceTypeStylesheet JsonNewParamsBodyObjectRejectResourceType = "stylesheet" JsonNewParamsBodyObjectRejectResourceTypeImage JsonNewParamsBodyObjectRejectResourceType = "image" JsonNewParamsBodyObjectRejectResourceTypeMedia JsonNewParamsBodyObjectRejectResourceType = "media" JsonNewParamsBodyObjectRejectResourceTypeFont JsonNewParamsBodyObjectRejectResourceType = "font" JsonNewParamsBodyObjectRejectResourceTypeScript JsonNewParamsBodyObjectRejectResourceType = "script" JsonNewParamsBodyObjectRejectResourceTypeTexttrack JsonNewParamsBodyObjectRejectResourceType = "texttrack" JsonNewParamsBodyObjectRejectResourceTypeXHR JsonNewParamsBodyObjectRejectResourceType = "xhr" JsonNewParamsBodyObjectRejectResourceTypeFetch JsonNewParamsBodyObjectRejectResourceType = "fetch" JsonNewParamsBodyObjectRejectResourceTypePrefetch JsonNewParamsBodyObjectRejectResourceType = "prefetch" JsonNewParamsBodyObjectRejectResourceTypeEventsource JsonNewParamsBodyObjectRejectResourceType = "eventsource" JsonNewParamsBodyObjectRejectResourceTypeWebsocket JsonNewParamsBodyObjectRejectResourceType = "websocket" JsonNewParamsBodyObjectRejectResourceTypeManifest JsonNewParamsBodyObjectRejectResourceType = "manifest" JsonNewParamsBodyObjectRejectResourceTypeSignedexchange JsonNewParamsBodyObjectRejectResourceType = "signedexchange" JsonNewParamsBodyObjectRejectResourceTypePing JsonNewParamsBodyObjectRejectResourceType = "ping" JsonNewParamsBodyObjectRejectResourceTypeCspviolationreport JsonNewParamsBodyObjectRejectResourceType = "cspviolationreport" JsonNewParamsBodyObjectRejectResourceTypePreflight JsonNewParamsBodyObjectRejectResourceType = "preflight" JsonNewParamsBodyObjectRejectResourceTypeOther JsonNewParamsBodyObjectRejectResourceType = "other" )
func (JsonNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectRejectResourceType) IsKnown() bool
type JsonNewParamsBodyObjectResponseFormat ¶ added in v6.6.0
type JsonNewParamsBodyObjectResponseFormat struct {
Type param.Field[string] `json:"type,required"`
// Schema for the response format. More information here:
// https://developers.cloudflare.com/workers-ai/json-mode/
JsonSchema param.Field[map[string]JsonNewParamsBodyObjectResponseFormatJsonSchemaUnion] `json:"json_schema"`
}
func (JsonNewParamsBodyObjectResponseFormat) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectResponseFormat) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectResponseFormatJsonSchemaArray ¶ added in v6.6.0
type JsonNewParamsBodyObjectResponseFormatJsonSchemaArray []string
func (JsonNewParamsBodyObjectResponseFormatJsonSchemaArray) ImplementsJsonNewParamsBodyObjectResponseFormatJsonSchemaUnion ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectResponseFormatJsonSchemaArray) ImplementsJsonNewParamsBodyObjectResponseFormatJsonSchemaUnion()
type JsonNewParamsBodyObjectResponseFormatJsonSchemaUnion ¶ added in v6.6.0
type JsonNewParamsBodyObjectResponseFormatJsonSchemaUnion interface {
ImplementsJsonNewParamsBodyObjectResponseFormatJsonSchemaUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool, browser_rendering.JsonNewParamsBodyObjectResponseFormatJsonSchemaArray.
Use [Raw()] to specify an arbitrary value for this param
type JsonNewParamsBodyObjectViewport ¶ added in v6.6.0
type JsonNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (JsonNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type JsonNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[JsonNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[JsonNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (JsonNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type JsonNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type JsonNewParamsBodyObjectWaitForSelectorHidden bool
const (
JsonNewParamsBodyObjectWaitForSelectorHiddenTrue JsonNewParamsBodyObjectWaitForSelectorHidden = true
)
func (JsonNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type JsonNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type JsonNewParamsBodyObjectWaitForSelectorVisible bool
const (
JsonNewParamsBodyObjectWaitForSelectorVisibleTrue JsonNewParamsBodyObjectWaitForSelectorVisible = true
)
func (JsonNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r JsonNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type JsonNewParamsBodyUnion ¶ added in v6.6.0
type JsonNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.JsonNewParamsBodyObject, browser_rendering.JsonNewParamsBodyObject, JsonNewParamsBody.
type JsonNewResponse ¶
type JsonNewResponse map[string]interface{}
type JsonNewResponseEnvelope ¶
type JsonNewResponseEnvelope struct {
Result JsonNewResponse `json:"result,required"`
// Response status
Success bool `json:"success,required"`
Errors []JsonNewResponseEnvelopeErrors `json:"errors"`
JSON jsonNewResponseEnvelopeJSON `json:"-"`
}
func (*JsonNewResponseEnvelope) UnmarshalJSON ¶
func (r *JsonNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type JsonNewResponseEnvelopeErrors ¶
type JsonNewResponseEnvelopeErrors struct {
// Error code
Code float64 `json:"code,required"`
// Error Message
Message string `json:"message,required"`
JSON jsonNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*JsonNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *JsonNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type JsonService ¶
type JsonService struct {
Options []option.RequestOption
}
JsonService 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 NewJsonService method instead.
func NewJsonService ¶
func NewJsonService(opts ...option.RequestOption) (r *JsonService)
NewJsonService 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 (*JsonService) New ¶
func (r *JsonService) New(ctx context.Context, params JsonNewParams, opts ...option.RequestOption) (res *JsonNewResponse, err error)
Gets json from a webpage from a provided URL or HTML. Pass `prompt` or `schema` in the body. Control page loading with `gotoOptions` and `waitFor*` options.
type LinkNewParams ¶
type LinkNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body LinkNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (LinkNewParams) MarshalJSON ¶
func (r LinkNewParams) MarshalJSON() (data []byte, err error)
func (LinkNewParams) URLQuery ¶
func (r LinkNewParams) URLQuery() (v url.Values)
URLQuery serializes LinkNewParams's query parameters as `url.Values`.
type LinkNewParamsBody ¶ added in v6.6.0
type LinkNewParamsBody struct {
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
ExcludeExternalLinks param.Field[bool] `json:"excludeExternalLinks"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
VisibleLinksOnly param.Field[bool] `json:"visibleLinksOnly"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (LinkNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBody) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObject ¶ added in v6.6.0
type LinkNewParamsBodyObject struct {
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html,required"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]LinkNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]LinkNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]LinkNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[LinkNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]LinkNewParamsBodyObjectCookie] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
ExcludeExternalLinks param.Field[bool] `json:"excludeExternalLinks"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[LinkNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]LinkNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[LinkNewParamsBodyObjectViewport] `json:"viewport"`
VisibleLinksOnly param.Field[bool] `json:"visibleLinksOnly"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[LinkNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (LinkNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type LinkNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (LinkNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type LinkNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (LinkNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type LinkNewParamsBodyObjectAllowResourceType string
const ( LinkNewParamsBodyObjectAllowResourceTypeDocument LinkNewParamsBodyObjectAllowResourceType = "document" LinkNewParamsBodyObjectAllowResourceTypeStylesheet LinkNewParamsBodyObjectAllowResourceType = "stylesheet" LinkNewParamsBodyObjectAllowResourceTypeImage LinkNewParamsBodyObjectAllowResourceType = "image" LinkNewParamsBodyObjectAllowResourceTypeMedia LinkNewParamsBodyObjectAllowResourceType = "media" LinkNewParamsBodyObjectAllowResourceTypeFont LinkNewParamsBodyObjectAllowResourceType = "font" LinkNewParamsBodyObjectAllowResourceTypeScript LinkNewParamsBodyObjectAllowResourceType = "script" LinkNewParamsBodyObjectAllowResourceTypeTexttrack LinkNewParamsBodyObjectAllowResourceType = "texttrack" LinkNewParamsBodyObjectAllowResourceTypeXHR LinkNewParamsBodyObjectAllowResourceType = "xhr" LinkNewParamsBodyObjectAllowResourceTypeFetch LinkNewParamsBodyObjectAllowResourceType = "fetch" LinkNewParamsBodyObjectAllowResourceTypePrefetch LinkNewParamsBodyObjectAllowResourceType = "prefetch" LinkNewParamsBodyObjectAllowResourceTypeEventsource LinkNewParamsBodyObjectAllowResourceType = "eventsource" LinkNewParamsBodyObjectAllowResourceTypeWebsocket LinkNewParamsBodyObjectAllowResourceType = "websocket" LinkNewParamsBodyObjectAllowResourceTypeManifest LinkNewParamsBodyObjectAllowResourceType = "manifest" LinkNewParamsBodyObjectAllowResourceTypeSignedexchange LinkNewParamsBodyObjectAllowResourceType = "signedexchange" LinkNewParamsBodyObjectAllowResourceTypePing LinkNewParamsBodyObjectAllowResourceType = "ping" LinkNewParamsBodyObjectAllowResourceTypeCspviolationreport LinkNewParamsBodyObjectAllowResourceType = "cspviolationreport" LinkNewParamsBodyObjectAllowResourceTypePreflight LinkNewParamsBodyObjectAllowResourceType = "preflight" LinkNewParamsBodyObjectAllowResourceTypeOther LinkNewParamsBodyObjectAllowResourceType = "other" )
func (LinkNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectAllowResourceType) IsKnown() bool
type LinkNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type LinkNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (LinkNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectCookie ¶ added in v6.6.0
type LinkNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[LinkNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[LinkNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[LinkNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (LinkNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type LinkNewParamsBodyObjectCookiesPriority string
const ( LinkNewParamsBodyObjectCookiesPriorityLow LinkNewParamsBodyObjectCookiesPriority = "Low" LinkNewParamsBodyObjectCookiesPriorityMedium LinkNewParamsBodyObjectCookiesPriority = "Medium" LinkNewParamsBodyObjectCookiesPriorityHigh LinkNewParamsBodyObjectCookiesPriority = "High" )
func (LinkNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectCookiesPriority) IsKnown() bool
type LinkNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type LinkNewParamsBodyObjectCookiesSameSite string
const ( LinkNewParamsBodyObjectCookiesSameSiteStrict LinkNewParamsBodyObjectCookiesSameSite = "Strict" LinkNewParamsBodyObjectCookiesSameSiteLax LinkNewParamsBodyObjectCookiesSameSite = "Lax" LinkNewParamsBodyObjectCookiesSameSiteNone LinkNewParamsBodyObjectCookiesSameSite = "None" )
func (LinkNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type LinkNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type LinkNewParamsBodyObjectCookiesSourceScheme string
const ( LinkNewParamsBodyObjectCookiesSourceSchemeUnset LinkNewParamsBodyObjectCookiesSourceScheme = "Unset" LinkNewParamsBodyObjectCookiesSourceSchemeNonSecure LinkNewParamsBodyObjectCookiesSourceScheme = "NonSecure" LinkNewParamsBodyObjectCookiesSourceSchemeSecure LinkNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (LinkNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type LinkNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type LinkNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[LinkNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (LinkNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type LinkNewParamsBodyObjectGotoOptionsWaitUntilArray []LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type LinkNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type LinkNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( LinkNewParamsBodyObjectGotoOptionsWaitUntilStringLoad LinkNewParamsBodyObjectGotoOptionsWaitUntilString = "load" LinkNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded LinkNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" LinkNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 LinkNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" LinkNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 LinkNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (LinkNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type LinkNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type LinkNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.LinkNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.LinkNewParamsBodyObjectGotoOptionsWaitUntilArray.
type LinkNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type LinkNewParamsBodyObjectRejectResourceType string
const ( LinkNewParamsBodyObjectRejectResourceTypeDocument LinkNewParamsBodyObjectRejectResourceType = "document" LinkNewParamsBodyObjectRejectResourceTypeStylesheet LinkNewParamsBodyObjectRejectResourceType = "stylesheet" LinkNewParamsBodyObjectRejectResourceTypeImage LinkNewParamsBodyObjectRejectResourceType = "image" LinkNewParamsBodyObjectRejectResourceTypeMedia LinkNewParamsBodyObjectRejectResourceType = "media" LinkNewParamsBodyObjectRejectResourceTypeFont LinkNewParamsBodyObjectRejectResourceType = "font" LinkNewParamsBodyObjectRejectResourceTypeScript LinkNewParamsBodyObjectRejectResourceType = "script" LinkNewParamsBodyObjectRejectResourceTypeTexttrack LinkNewParamsBodyObjectRejectResourceType = "texttrack" LinkNewParamsBodyObjectRejectResourceTypeXHR LinkNewParamsBodyObjectRejectResourceType = "xhr" LinkNewParamsBodyObjectRejectResourceTypeFetch LinkNewParamsBodyObjectRejectResourceType = "fetch" LinkNewParamsBodyObjectRejectResourceTypePrefetch LinkNewParamsBodyObjectRejectResourceType = "prefetch" LinkNewParamsBodyObjectRejectResourceTypeEventsource LinkNewParamsBodyObjectRejectResourceType = "eventsource" LinkNewParamsBodyObjectRejectResourceTypeWebsocket LinkNewParamsBodyObjectRejectResourceType = "websocket" LinkNewParamsBodyObjectRejectResourceTypeManifest LinkNewParamsBodyObjectRejectResourceType = "manifest" LinkNewParamsBodyObjectRejectResourceTypeSignedexchange LinkNewParamsBodyObjectRejectResourceType = "signedexchange" LinkNewParamsBodyObjectRejectResourceTypePing LinkNewParamsBodyObjectRejectResourceType = "ping" LinkNewParamsBodyObjectRejectResourceTypeCspviolationreport LinkNewParamsBodyObjectRejectResourceType = "cspviolationreport" LinkNewParamsBodyObjectRejectResourceTypePreflight LinkNewParamsBodyObjectRejectResourceType = "preflight" LinkNewParamsBodyObjectRejectResourceTypeOther LinkNewParamsBodyObjectRejectResourceType = "other" )
func (LinkNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectRejectResourceType) IsKnown() bool
type LinkNewParamsBodyObjectViewport ¶ added in v6.6.0
type LinkNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (LinkNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type LinkNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[LinkNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[LinkNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (LinkNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type LinkNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type LinkNewParamsBodyObjectWaitForSelectorHidden bool
const (
LinkNewParamsBodyObjectWaitForSelectorHiddenTrue LinkNewParamsBodyObjectWaitForSelectorHidden = true
)
func (LinkNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type LinkNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type LinkNewParamsBodyObjectWaitForSelectorVisible bool
const (
LinkNewParamsBodyObjectWaitForSelectorVisibleTrue LinkNewParamsBodyObjectWaitForSelectorVisible = true
)
func (LinkNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r LinkNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type LinkNewParamsBodyUnion ¶ added in v6.6.0
type LinkNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.LinkNewParamsBodyObject, browser_rendering.LinkNewParamsBodyObject, LinkNewParamsBody.
type LinkNewResponseEnvelope ¶
type LinkNewResponseEnvelope struct {
Result []string `json:"result,required"`
// Response status
Success bool `json:"success,required"`
Errors []LinkNewResponseEnvelopeErrors `json:"errors"`
JSON linkNewResponseEnvelopeJSON `json:"-"`
}
func (*LinkNewResponseEnvelope) UnmarshalJSON ¶
func (r *LinkNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type LinkNewResponseEnvelopeErrors ¶
type LinkNewResponseEnvelopeErrors struct {
// Error code
Code float64 `json:"code,required"`
// Error Message
Message string `json:"message,required"`
JSON linkNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*LinkNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *LinkNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type LinkService ¶
type LinkService struct {
Options []option.RequestOption
}
LinkService 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 NewLinkService method instead.
func NewLinkService ¶
func NewLinkService(opts ...option.RequestOption) (r *LinkService)
NewLinkService 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 (*LinkService) New ¶
func (r *LinkService) New(ctx context.Context, params LinkNewParams, opts ...option.RequestOption) (res *[]string, err error)
Get links from a web page.
type MarkdownNewParams ¶
type MarkdownNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body MarkdownNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (MarkdownNewParams) MarshalJSON ¶
func (r MarkdownNewParams) MarshalJSON() (data []byte, err error)
func (MarkdownNewParams) URLQuery ¶
func (r MarkdownNewParams) URLQuery() (v url.Values)
URLQuery serializes MarkdownNewParams's query parameters as `url.Values`.
type MarkdownNewParamsBody ¶ added in v6.6.0
type MarkdownNewParamsBody struct {
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (MarkdownNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBody) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObject ¶ added in v6.6.0
type MarkdownNewParamsBodyObject struct {
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url,required" format:"uri"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]MarkdownNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]MarkdownNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]MarkdownNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[MarkdownNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]MarkdownNewParamsBodyObjectCookie] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[MarkdownNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]MarkdownNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[MarkdownNewParamsBodyObjectViewport] `json:"viewport"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[MarkdownNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (MarkdownNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (MarkdownNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (MarkdownNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectAllowResourceType string
const ( MarkdownNewParamsBodyObjectAllowResourceTypeDocument MarkdownNewParamsBodyObjectAllowResourceType = "document" MarkdownNewParamsBodyObjectAllowResourceTypeStylesheet MarkdownNewParamsBodyObjectAllowResourceType = "stylesheet" MarkdownNewParamsBodyObjectAllowResourceTypeImage MarkdownNewParamsBodyObjectAllowResourceType = "image" MarkdownNewParamsBodyObjectAllowResourceTypeMedia MarkdownNewParamsBodyObjectAllowResourceType = "media" MarkdownNewParamsBodyObjectAllowResourceTypeFont MarkdownNewParamsBodyObjectAllowResourceType = "font" MarkdownNewParamsBodyObjectAllowResourceTypeScript MarkdownNewParamsBodyObjectAllowResourceType = "script" MarkdownNewParamsBodyObjectAllowResourceTypeTexttrack MarkdownNewParamsBodyObjectAllowResourceType = "texttrack" MarkdownNewParamsBodyObjectAllowResourceTypeXHR MarkdownNewParamsBodyObjectAllowResourceType = "xhr" MarkdownNewParamsBodyObjectAllowResourceTypeFetch MarkdownNewParamsBodyObjectAllowResourceType = "fetch" MarkdownNewParamsBodyObjectAllowResourceTypePrefetch MarkdownNewParamsBodyObjectAllowResourceType = "prefetch" MarkdownNewParamsBodyObjectAllowResourceTypeEventsource MarkdownNewParamsBodyObjectAllowResourceType = "eventsource" MarkdownNewParamsBodyObjectAllowResourceTypeWebsocket MarkdownNewParamsBodyObjectAllowResourceType = "websocket" MarkdownNewParamsBodyObjectAllowResourceTypeManifest MarkdownNewParamsBodyObjectAllowResourceType = "manifest" MarkdownNewParamsBodyObjectAllowResourceTypeSignedexchange MarkdownNewParamsBodyObjectAllowResourceType = "signedexchange" MarkdownNewParamsBodyObjectAllowResourceTypePing MarkdownNewParamsBodyObjectAllowResourceType = "ping" MarkdownNewParamsBodyObjectAllowResourceTypeCspviolationreport MarkdownNewParamsBodyObjectAllowResourceType = "cspviolationreport" MarkdownNewParamsBodyObjectAllowResourceTypePreflight MarkdownNewParamsBodyObjectAllowResourceType = "preflight" MarkdownNewParamsBodyObjectAllowResourceTypeOther MarkdownNewParamsBodyObjectAllowResourceType = "other" )
func (MarkdownNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectAllowResourceType) IsKnown() bool
type MarkdownNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (MarkdownNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectCookie ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[MarkdownNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[MarkdownNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[MarkdownNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (MarkdownNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectCookiesPriority string
const ( MarkdownNewParamsBodyObjectCookiesPriorityLow MarkdownNewParamsBodyObjectCookiesPriority = "Low" MarkdownNewParamsBodyObjectCookiesPriorityMedium MarkdownNewParamsBodyObjectCookiesPriority = "Medium" MarkdownNewParamsBodyObjectCookiesPriorityHigh MarkdownNewParamsBodyObjectCookiesPriority = "High" )
func (MarkdownNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectCookiesPriority) IsKnown() bool
type MarkdownNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectCookiesSameSite string
const ( MarkdownNewParamsBodyObjectCookiesSameSiteStrict MarkdownNewParamsBodyObjectCookiesSameSite = "Strict" MarkdownNewParamsBodyObjectCookiesSameSiteLax MarkdownNewParamsBodyObjectCookiesSameSite = "Lax" MarkdownNewParamsBodyObjectCookiesSameSiteNone MarkdownNewParamsBodyObjectCookiesSameSite = "None" )
func (MarkdownNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type MarkdownNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectCookiesSourceScheme string
const ( MarkdownNewParamsBodyObjectCookiesSourceSchemeUnset MarkdownNewParamsBodyObjectCookiesSourceScheme = "Unset" MarkdownNewParamsBodyObjectCookiesSourceSchemeNonSecure MarkdownNewParamsBodyObjectCookiesSourceScheme = "NonSecure" MarkdownNewParamsBodyObjectCookiesSourceSchemeSecure MarkdownNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (MarkdownNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type MarkdownNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[MarkdownNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (MarkdownNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArray []MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( MarkdownNewParamsBodyObjectGotoOptionsWaitUntilStringLoad MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString = "load" MarkdownNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" MarkdownNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" MarkdownNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.MarkdownNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.MarkdownNewParamsBodyObjectGotoOptionsWaitUntilArray.
type MarkdownNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectRejectResourceType string
const ( MarkdownNewParamsBodyObjectRejectResourceTypeDocument MarkdownNewParamsBodyObjectRejectResourceType = "document" MarkdownNewParamsBodyObjectRejectResourceTypeStylesheet MarkdownNewParamsBodyObjectRejectResourceType = "stylesheet" MarkdownNewParamsBodyObjectRejectResourceTypeImage MarkdownNewParamsBodyObjectRejectResourceType = "image" MarkdownNewParamsBodyObjectRejectResourceTypeMedia MarkdownNewParamsBodyObjectRejectResourceType = "media" MarkdownNewParamsBodyObjectRejectResourceTypeFont MarkdownNewParamsBodyObjectRejectResourceType = "font" MarkdownNewParamsBodyObjectRejectResourceTypeScript MarkdownNewParamsBodyObjectRejectResourceType = "script" MarkdownNewParamsBodyObjectRejectResourceTypeTexttrack MarkdownNewParamsBodyObjectRejectResourceType = "texttrack" MarkdownNewParamsBodyObjectRejectResourceTypeXHR MarkdownNewParamsBodyObjectRejectResourceType = "xhr" MarkdownNewParamsBodyObjectRejectResourceTypeFetch MarkdownNewParamsBodyObjectRejectResourceType = "fetch" MarkdownNewParamsBodyObjectRejectResourceTypePrefetch MarkdownNewParamsBodyObjectRejectResourceType = "prefetch" MarkdownNewParamsBodyObjectRejectResourceTypeEventsource MarkdownNewParamsBodyObjectRejectResourceType = "eventsource" MarkdownNewParamsBodyObjectRejectResourceTypeWebsocket MarkdownNewParamsBodyObjectRejectResourceType = "websocket" MarkdownNewParamsBodyObjectRejectResourceTypeManifest MarkdownNewParamsBodyObjectRejectResourceType = "manifest" MarkdownNewParamsBodyObjectRejectResourceTypeSignedexchange MarkdownNewParamsBodyObjectRejectResourceType = "signedexchange" MarkdownNewParamsBodyObjectRejectResourceTypePing MarkdownNewParamsBodyObjectRejectResourceType = "ping" MarkdownNewParamsBodyObjectRejectResourceTypeCspviolationreport MarkdownNewParamsBodyObjectRejectResourceType = "cspviolationreport" MarkdownNewParamsBodyObjectRejectResourceTypePreflight MarkdownNewParamsBodyObjectRejectResourceType = "preflight" MarkdownNewParamsBodyObjectRejectResourceTypeOther MarkdownNewParamsBodyObjectRejectResourceType = "other" )
func (MarkdownNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectRejectResourceType) IsKnown() bool
type MarkdownNewParamsBodyObjectViewport ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (MarkdownNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[MarkdownNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[MarkdownNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (MarkdownNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type MarkdownNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectWaitForSelectorHidden bool
const (
MarkdownNewParamsBodyObjectWaitForSelectorHiddenTrue MarkdownNewParamsBodyObjectWaitForSelectorHidden = true
)
func (MarkdownNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type MarkdownNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type MarkdownNewParamsBodyObjectWaitForSelectorVisible bool
const (
MarkdownNewParamsBodyObjectWaitForSelectorVisibleTrue MarkdownNewParamsBodyObjectWaitForSelectorVisible = true
)
func (MarkdownNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r MarkdownNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type MarkdownNewParamsBodyUnion ¶ added in v6.6.0
type MarkdownNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.MarkdownNewParamsBodyObject, browser_rendering.MarkdownNewParamsBodyObject, MarkdownNewParamsBody.
type MarkdownNewResponseEnvelope ¶
type MarkdownNewResponseEnvelope struct {
// Response status
Success bool `json:"success,required"`
Errors []MarkdownNewResponseEnvelopeErrors `json:"errors"`
// Markdown
Result string `json:"result"`
JSON markdownNewResponseEnvelopeJSON `json:"-"`
}
func (*MarkdownNewResponseEnvelope) UnmarshalJSON ¶
func (r *MarkdownNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type MarkdownNewResponseEnvelopeErrors ¶
type MarkdownNewResponseEnvelopeErrors struct {
// Error code
Code float64 `json:"code,required"`
// Error Message
Message string `json:"message,required"`
JSON markdownNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*MarkdownNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *MarkdownNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type MarkdownService ¶
type MarkdownService struct {
Options []option.RequestOption
}
MarkdownService 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 NewMarkdownService method instead.
func NewMarkdownService ¶
func NewMarkdownService(opts ...option.RequestOption) (r *MarkdownService)
NewMarkdownService 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 (*MarkdownService) New ¶
func (r *MarkdownService) New(ctx context.Context, params MarkdownNewParams, opts ...option.RequestOption) (res *string, err error)
Gets markdown of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type PDFNewParams ¶
type PDFNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body PDFNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (PDFNewParams) MarshalJSON ¶
func (r PDFNewParams) MarshalJSON() (data []byte, err error)
func (PDFNewParams) URLQuery ¶
func (r PDFNewParams) URLQuery() (v url.Values)
URLQuery serializes PDFNewParams's query parameters as `url.Values`.
type PDFNewParamsBody ¶ added in v6.6.0
type PDFNewParamsBody struct {
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
PDFOptions param.Field[interface{}] `json:"pdfOptions"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (PDFNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBody) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObject ¶ added in v6.6.0
type PDFNewParamsBodyObject struct {
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html,required"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]PDFNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]PDFNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]PDFNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[PDFNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]PDFNewParamsBodyObjectCookie] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[PDFNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
// Check [options](https://pptr.dev/api/puppeteer.pdfoptions).
PDFOptions param.Field[PDFNewParamsBodyObjectPDFOptions] `json:"pdfOptions"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]PDFNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[PDFNewParamsBodyObjectViewport] `json:"viewport"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[PDFNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (PDFNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type PDFNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (PDFNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type PDFNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (PDFNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type PDFNewParamsBodyObjectAllowResourceType string
const ( PDFNewParamsBodyObjectAllowResourceTypeDocument PDFNewParamsBodyObjectAllowResourceType = "document" PDFNewParamsBodyObjectAllowResourceTypeStylesheet PDFNewParamsBodyObjectAllowResourceType = "stylesheet" PDFNewParamsBodyObjectAllowResourceTypeImage PDFNewParamsBodyObjectAllowResourceType = "image" PDFNewParamsBodyObjectAllowResourceTypeMedia PDFNewParamsBodyObjectAllowResourceType = "media" PDFNewParamsBodyObjectAllowResourceTypeFont PDFNewParamsBodyObjectAllowResourceType = "font" PDFNewParamsBodyObjectAllowResourceTypeScript PDFNewParamsBodyObjectAllowResourceType = "script" PDFNewParamsBodyObjectAllowResourceTypeTexttrack PDFNewParamsBodyObjectAllowResourceType = "texttrack" PDFNewParamsBodyObjectAllowResourceTypeXHR PDFNewParamsBodyObjectAllowResourceType = "xhr" PDFNewParamsBodyObjectAllowResourceTypeFetch PDFNewParamsBodyObjectAllowResourceType = "fetch" PDFNewParamsBodyObjectAllowResourceTypePrefetch PDFNewParamsBodyObjectAllowResourceType = "prefetch" PDFNewParamsBodyObjectAllowResourceTypeEventsource PDFNewParamsBodyObjectAllowResourceType = "eventsource" PDFNewParamsBodyObjectAllowResourceTypeWebsocket PDFNewParamsBodyObjectAllowResourceType = "websocket" PDFNewParamsBodyObjectAllowResourceTypeManifest PDFNewParamsBodyObjectAllowResourceType = "manifest" PDFNewParamsBodyObjectAllowResourceTypeSignedexchange PDFNewParamsBodyObjectAllowResourceType = "signedexchange" PDFNewParamsBodyObjectAllowResourceTypePing PDFNewParamsBodyObjectAllowResourceType = "ping" PDFNewParamsBodyObjectAllowResourceTypeCspviolationreport PDFNewParamsBodyObjectAllowResourceType = "cspviolationreport" PDFNewParamsBodyObjectAllowResourceTypePreflight PDFNewParamsBodyObjectAllowResourceType = "preflight" PDFNewParamsBodyObjectAllowResourceTypeOther PDFNewParamsBodyObjectAllowResourceType = "other" )
func (PDFNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectAllowResourceType) IsKnown() bool
type PDFNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type PDFNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (PDFNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectCookie ¶ added in v6.6.0
type PDFNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[PDFNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[PDFNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[PDFNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (PDFNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type PDFNewParamsBodyObjectCookiesPriority string
const ( PDFNewParamsBodyObjectCookiesPriorityLow PDFNewParamsBodyObjectCookiesPriority = "Low" PDFNewParamsBodyObjectCookiesPriorityMedium PDFNewParamsBodyObjectCookiesPriority = "Medium" PDFNewParamsBodyObjectCookiesPriorityHigh PDFNewParamsBodyObjectCookiesPriority = "High" )
func (PDFNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectCookiesPriority) IsKnown() bool
type PDFNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type PDFNewParamsBodyObjectCookiesSameSite string
const ( PDFNewParamsBodyObjectCookiesSameSiteStrict PDFNewParamsBodyObjectCookiesSameSite = "Strict" PDFNewParamsBodyObjectCookiesSameSiteLax PDFNewParamsBodyObjectCookiesSameSite = "Lax" PDFNewParamsBodyObjectCookiesSameSiteNone PDFNewParamsBodyObjectCookiesSameSite = "None" )
func (PDFNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type PDFNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type PDFNewParamsBodyObjectCookiesSourceScheme string
const ( PDFNewParamsBodyObjectCookiesSourceSchemeUnset PDFNewParamsBodyObjectCookiesSourceScheme = "Unset" PDFNewParamsBodyObjectCookiesSourceSchemeNonSecure PDFNewParamsBodyObjectCookiesSourceScheme = "NonSecure" PDFNewParamsBodyObjectCookiesSourceSchemeSecure PDFNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (PDFNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type PDFNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type PDFNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[PDFNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (PDFNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type PDFNewParamsBodyObjectGotoOptionsWaitUntilArray []PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type PDFNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type PDFNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( PDFNewParamsBodyObjectGotoOptionsWaitUntilStringLoad PDFNewParamsBodyObjectGotoOptionsWaitUntilString = "load" PDFNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded PDFNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" PDFNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 PDFNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" PDFNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 PDFNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (PDFNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type PDFNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type PDFNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.PDFNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.PDFNewParamsBodyObjectGotoOptionsWaitUntilArray.
type PDFNewParamsBodyObjectPDFOptions ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptions struct {
DisplayHeaderFooter param.Field[bool] `json:"displayHeaderFooter"`
FooterTemplate param.Field[string] `json:"footerTemplate"`
// Paper format. Takes priority over width and height if set.
Format param.Field[PDFNewParamsBodyObjectPDFOptionsFormat] `json:"format"`
// HTML template for the print header.
HeaderTemplate param.Field[string] `json:"headerTemplate"`
// Sets the height of paper. Can be a number or string with unit.
Height param.Field[PDFNewParamsBodyObjectPDFOptionsHeightUnion] `json:"height"`
// Whether to print in landscape orientation.
Landscape param.Field[bool] `json:"landscape"`
// Set the PDF margins. Useful when setting header and footer.
Margin param.Field[PDFNewParamsBodyObjectPDFOptionsMargin] `json:"margin"`
// Hides default white background and allows generating pdfs with transparency.
OmitBackground param.Field[bool] `json:"omitBackground"`
// Generate document outline.
Outline param.Field[bool] `json:"outline"`
// Paper ranges to print, e.g. '1-5, 8, 11-13'.
PageRanges param.Field[string] `json:"pageRanges"`
// Give CSS @page size priority over other size declarations.
PreferCSSPageSize param.Field[bool] `json:"preferCSSPageSize"`
// Set to true to print background graphics.
PrintBackground param.Field[bool] `json:"printBackground"`
// Scales the rendering of the web page. Amount must be between 0.1 and 2.
Scale param.Field[float64] `json:"scale"`
// Generate tagged (accessible) PDF.
Tagged param.Field[bool] `json:"tagged"`
// Timeout in milliseconds.
Timeout param.Field[float64] `json:"timeout"`
// Sets the width of paper. Can be a number or string with unit.
Width param.Field[PDFNewParamsBodyObjectPDFOptionsWidthUnion] `json:"width"`
}
Check [options](https://pptr.dev/api/puppeteer.pdfoptions).
func (PDFNewParamsBodyObjectPDFOptions) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectPDFOptions) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectPDFOptionsFormat ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsFormat string
Paper format. Takes priority over width and height if set.
const ( PDFNewParamsBodyObjectPDFOptionsFormatLetter PDFNewParamsBodyObjectPDFOptionsFormat = "letter" PDFNewParamsBodyObjectPDFOptionsFormatLegal PDFNewParamsBodyObjectPDFOptionsFormat = "legal" PDFNewParamsBodyObjectPDFOptionsFormatTabloid PDFNewParamsBodyObjectPDFOptionsFormat = "tabloid" PDFNewParamsBodyObjectPDFOptionsFormatLedger PDFNewParamsBodyObjectPDFOptionsFormat = "ledger" PDFNewParamsBodyObjectPDFOptionsFormatA0 PDFNewParamsBodyObjectPDFOptionsFormat = "a0" PDFNewParamsBodyObjectPDFOptionsFormatA1 PDFNewParamsBodyObjectPDFOptionsFormat = "a1" PDFNewParamsBodyObjectPDFOptionsFormatA2 PDFNewParamsBodyObjectPDFOptionsFormat = "a2" PDFNewParamsBodyObjectPDFOptionsFormatA3 PDFNewParamsBodyObjectPDFOptionsFormat = "a3" PDFNewParamsBodyObjectPDFOptionsFormatA4 PDFNewParamsBodyObjectPDFOptionsFormat = "a4" PDFNewParamsBodyObjectPDFOptionsFormatA5 PDFNewParamsBodyObjectPDFOptionsFormat = "a5" PDFNewParamsBodyObjectPDFOptionsFormatA6 PDFNewParamsBodyObjectPDFOptionsFormat = "a6" )
func (PDFNewParamsBodyObjectPDFOptionsFormat) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectPDFOptionsFormat) IsKnown() bool
type PDFNewParamsBodyObjectPDFOptionsHeightUnion ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsHeightUnion interface {
ImplementsPDFNewParamsBodyObjectPDFOptionsHeightUnion()
}
Sets the height of paper. Can be a number or string with unit.
Satisfied by shared.UnionString, shared.UnionFloat.
type PDFNewParamsBodyObjectPDFOptionsMargin ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsMargin struct {
Bottom param.Field[PDFNewParamsBodyObjectPDFOptionsMarginBottomUnion] `json:"bottom"`
Left param.Field[PDFNewParamsBodyObjectPDFOptionsMarginLeftUnion] `json:"left"`
Right param.Field[PDFNewParamsBodyObjectPDFOptionsMarginRightUnion] `json:"right"`
Top param.Field[PDFNewParamsBodyObjectPDFOptionsMarginTopUnion] `json:"top"`
}
Set the PDF margins. Useful when setting header and footer.
func (PDFNewParamsBodyObjectPDFOptionsMargin) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectPDFOptionsMargin) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectPDFOptionsMarginBottomUnion ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsMarginBottomUnion interface {
ImplementsPDFNewParamsBodyObjectPDFOptionsMarginBottomUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type PDFNewParamsBodyObjectPDFOptionsMarginLeftUnion ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsMarginLeftUnion interface {
ImplementsPDFNewParamsBodyObjectPDFOptionsMarginLeftUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type PDFNewParamsBodyObjectPDFOptionsMarginRightUnion ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsMarginRightUnion interface {
ImplementsPDFNewParamsBodyObjectPDFOptionsMarginRightUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type PDFNewParamsBodyObjectPDFOptionsMarginTopUnion ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsMarginTopUnion interface {
ImplementsPDFNewParamsBodyObjectPDFOptionsMarginTopUnion()
}
Satisfied by shared.UnionString, shared.UnionFloat.
type PDFNewParamsBodyObjectPDFOptionsWidthUnion ¶ added in v6.6.0
type PDFNewParamsBodyObjectPDFOptionsWidthUnion interface {
ImplementsPDFNewParamsBodyObjectPDFOptionsWidthUnion()
}
Sets the width of paper. Can be a number or string with unit.
Satisfied by shared.UnionString, shared.UnionFloat.
type PDFNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type PDFNewParamsBodyObjectRejectResourceType string
const ( PDFNewParamsBodyObjectRejectResourceTypeDocument PDFNewParamsBodyObjectRejectResourceType = "document" PDFNewParamsBodyObjectRejectResourceTypeStylesheet PDFNewParamsBodyObjectRejectResourceType = "stylesheet" PDFNewParamsBodyObjectRejectResourceTypeImage PDFNewParamsBodyObjectRejectResourceType = "image" PDFNewParamsBodyObjectRejectResourceTypeMedia PDFNewParamsBodyObjectRejectResourceType = "media" PDFNewParamsBodyObjectRejectResourceTypeFont PDFNewParamsBodyObjectRejectResourceType = "font" PDFNewParamsBodyObjectRejectResourceTypeScript PDFNewParamsBodyObjectRejectResourceType = "script" PDFNewParamsBodyObjectRejectResourceTypeTexttrack PDFNewParamsBodyObjectRejectResourceType = "texttrack" PDFNewParamsBodyObjectRejectResourceTypeXHR PDFNewParamsBodyObjectRejectResourceType = "xhr" PDFNewParamsBodyObjectRejectResourceTypeFetch PDFNewParamsBodyObjectRejectResourceType = "fetch" PDFNewParamsBodyObjectRejectResourceTypePrefetch PDFNewParamsBodyObjectRejectResourceType = "prefetch" PDFNewParamsBodyObjectRejectResourceTypeEventsource PDFNewParamsBodyObjectRejectResourceType = "eventsource" PDFNewParamsBodyObjectRejectResourceTypeWebsocket PDFNewParamsBodyObjectRejectResourceType = "websocket" PDFNewParamsBodyObjectRejectResourceTypeManifest PDFNewParamsBodyObjectRejectResourceType = "manifest" PDFNewParamsBodyObjectRejectResourceTypeSignedexchange PDFNewParamsBodyObjectRejectResourceType = "signedexchange" PDFNewParamsBodyObjectRejectResourceTypePing PDFNewParamsBodyObjectRejectResourceType = "ping" PDFNewParamsBodyObjectRejectResourceTypeCspviolationreport PDFNewParamsBodyObjectRejectResourceType = "cspviolationreport" PDFNewParamsBodyObjectRejectResourceTypePreflight PDFNewParamsBodyObjectRejectResourceType = "preflight" PDFNewParamsBodyObjectRejectResourceTypeOther PDFNewParamsBodyObjectRejectResourceType = "other" )
func (PDFNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectRejectResourceType) IsKnown() bool
type PDFNewParamsBodyObjectViewport ¶ added in v6.6.0
type PDFNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (PDFNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type PDFNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[PDFNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[PDFNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (PDFNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type PDFNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type PDFNewParamsBodyObjectWaitForSelectorHidden bool
const (
PDFNewParamsBodyObjectWaitForSelectorHiddenTrue PDFNewParamsBodyObjectWaitForSelectorHidden = true
)
func (PDFNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type PDFNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type PDFNewParamsBodyObjectWaitForSelectorVisible bool
const (
PDFNewParamsBodyObjectWaitForSelectorVisibleTrue PDFNewParamsBodyObjectWaitForSelectorVisible = true
)
func (PDFNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r PDFNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type PDFNewParamsBodyUnion ¶ added in v6.6.0
type PDFNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.PDFNewParamsBodyObject, browser_rendering.PDFNewParamsBodyObject, PDFNewParamsBody.
type PDFService ¶
type PDFService struct {
Options []option.RequestOption
}
PDFService 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 NewPDFService method instead.
func NewPDFService ¶
func NewPDFService(opts ...option.RequestOption) (r *PDFService)
NewPDFService 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 (*PDFService) New ¶
func (r *PDFService) New(ctx context.Context, params PDFNewParams, opts ...option.RequestOption) (res *http.Response, err error)
Fetches rendered PDF from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.
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 RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
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 ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type ScrapeNewParams ¶
type ScrapeNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body ScrapeNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (ScrapeNewParams) MarshalJSON ¶
func (r ScrapeNewParams) MarshalJSON() (data []byte, err error)
func (ScrapeNewParams) URLQuery ¶
func (r ScrapeNewParams) URLQuery() (v url.Values)
URLQuery serializes ScrapeNewParams's query parameters as `url.Values`.
type ScrapeNewParamsBody ¶ added in v6.6.0
type ScrapeNewParamsBody struct {
Elements param.Field[interface{}] `json:"elements,required"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (ScrapeNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBody) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObject ¶ added in v6.6.0
type ScrapeNewParamsBodyObject struct {
Elements param.Field[[]ScrapeNewParamsBodyObjectElement] `json:"elements,required"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html,required"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]ScrapeNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]ScrapeNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]ScrapeNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[ScrapeNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]ScrapeNewParamsBodyObjectCookie] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[ScrapeNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]ScrapeNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[ScrapeNewParamsBodyObjectViewport] `json:"viewport"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[ScrapeNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (ScrapeNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (ScrapeNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (ScrapeNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectAllowResourceType string
const ( ScrapeNewParamsBodyObjectAllowResourceTypeDocument ScrapeNewParamsBodyObjectAllowResourceType = "document" ScrapeNewParamsBodyObjectAllowResourceTypeStylesheet ScrapeNewParamsBodyObjectAllowResourceType = "stylesheet" ScrapeNewParamsBodyObjectAllowResourceTypeImage ScrapeNewParamsBodyObjectAllowResourceType = "image" ScrapeNewParamsBodyObjectAllowResourceTypeMedia ScrapeNewParamsBodyObjectAllowResourceType = "media" ScrapeNewParamsBodyObjectAllowResourceTypeFont ScrapeNewParamsBodyObjectAllowResourceType = "font" ScrapeNewParamsBodyObjectAllowResourceTypeScript ScrapeNewParamsBodyObjectAllowResourceType = "script" ScrapeNewParamsBodyObjectAllowResourceTypeTexttrack ScrapeNewParamsBodyObjectAllowResourceType = "texttrack" ScrapeNewParamsBodyObjectAllowResourceTypeXHR ScrapeNewParamsBodyObjectAllowResourceType = "xhr" ScrapeNewParamsBodyObjectAllowResourceTypeFetch ScrapeNewParamsBodyObjectAllowResourceType = "fetch" ScrapeNewParamsBodyObjectAllowResourceTypePrefetch ScrapeNewParamsBodyObjectAllowResourceType = "prefetch" ScrapeNewParamsBodyObjectAllowResourceTypeEventsource ScrapeNewParamsBodyObjectAllowResourceType = "eventsource" ScrapeNewParamsBodyObjectAllowResourceTypeWebsocket ScrapeNewParamsBodyObjectAllowResourceType = "websocket" ScrapeNewParamsBodyObjectAllowResourceTypeManifest ScrapeNewParamsBodyObjectAllowResourceType = "manifest" ScrapeNewParamsBodyObjectAllowResourceTypeSignedexchange ScrapeNewParamsBodyObjectAllowResourceType = "signedexchange" ScrapeNewParamsBodyObjectAllowResourceTypePing ScrapeNewParamsBodyObjectAllowResourceType = "ping" ScrapeNewParamsBodyObjectAllowResourceTypeCspviolationreport ScrapeNewParamsBodyObjectAllowResourceType = "cspviolationreport" ScrapeNewParamsBodyObjectAllowResourceTypePreflight ScrapeNewParamsBodyObjectAllowResourceType = "preflight" ScrapeNewParamsBodyObjectAllowResourceTypeOther ScrapeNewParamsBodyObjectAllowResourceType = "other" )
func (ScrapeNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectAllowResourceType) IsKnown() bool
type ScrapeNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (ScrapeNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectCookie ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[ScrapeNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[ScrapeNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[ScrapeNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (ScrapeNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectCookiesPriority string
const ( ScrapeNewParamsBodyObjectCookiesPriorityLow ScrapeNewParamsBodyObjectCookiesPriority = "Low" ScrapeNewParamsBodyObjectCookiesPriorityMedium ScrapeNewParamsBodyObjectCookiesPriority = "Medium" ScrapeNewParamsBodyObjectCookiesPriorityHigh ScrapeNewParamsBodyObjectCookiesPriority = "High" )
func (ScrapeNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectCookiesPriority) IsKnown() bool
type ScrapeNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectCookiesSameSite string
const ( ScrapeNewParamsBodyObjectCookiesSameSiteStrict ScrapeNewParamsBodyObjectCookiesSameSite = "Strict" ScrapeNewParamsBodyObjectCookiesSameSiteLax ScrapeNewParamsBodyObjectCookiesSameSite = "Lax" ScrapeNewParamsBodyObjectCookiesSameSiteNone ScrapeNewParamsBodyObjectCookiesSameSite = "None" )
func (ScrapeNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type ScrapeNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectCookiesSourceScheme string
const ( ScrapeNewParamsBodyObjectCookiesSourceSchemeUnset ScrapeNewParamsBodyObjectCookiesSourceScheme = "Unset" ScrapeNewParamsBodyObjectCookiesSourceSchemeNonSecure ScrapeNewParamsBodyObjectCookiesSourceScheme = "NonSecure" ScrapeNewParamsBodyObjectCookiesSourceSchemeSecure ScrapeNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (ScrapeNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type ScrapeNewParamsBodyObjectElement ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectElement struct {
Selector param.Field[string] `json:"selector,required"`
}
func (ScrapeNewParamsBodyObjectElement) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectElement) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[ScrapeNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (ScrapeNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArray []ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( ScrapeNewParamsBodyObjectGotoOptionsWaitUntilStringLoad ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString = "load" ScrapeNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" ScrapeNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" ScrapeNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.ScrapeNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.ScrapeNewParamsBodyObjectGotoOptionsWaitUntilArray.
type ScrapeNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectRejectResourceType string
const ( ScrapeNewParamsBodyObjectRejectResourceTypeDocument ScrapeNewParamsBodyObjectRejectResourceType = "document" ScrapeNewParamsBodyObjectRejectResourceTypeStylesheet ScrapeNewParamsBodyObjectRejectResourceType = "stylesheet" ScrapeNewParamsBodyObjectRejectResourceTypeImage ScrapeNewParamsBodyObjectRejectResourceType = "image" ScrapeNewParamsBodyObjectRejectResourceTypeMedia ScrapeNewParamsBodyObjectRejectResourceType = "media" ScrapeNewParamsBodyObjectRejectResourceTypeFont ScrapeNewParamsBodyObjectRejectResourceType = "font" ScrapeNewParamsBodyObjectRejectResourceTypeScript ScrapeNewParamsBodyObjectRejectResourceType = "script" ScrapeNewParamsBodyObjectRejectResourceTypeTexttrack ScrapeNewParamsBodyObjectRejectResourceType = "texttrack" ScrapeNewParamsBodyObjectRejectResourceTypeXHR ScrapeNewParamsBodyObjectRejectResourceType = "xhr" ScrapeNewParamsBodyObjectRejectResourceTypeFetch ScrapeNewParamsBodyObjectRejectResourceType = "fetch" ScrapeNewParamsBodyObjectRejectResourceTypePrefetch ScrapeNewParamsBodyObjectRejectResourceType = "prefetch" ScrapeNewParamsBodyObjectRejectResourceTypeEventsource ScrapeNewParamsBodyObjectRejectResourceType = "eventsource" ScrapeNewParamsBodyObjectRejectResourceTypeWebsocket ScrapeNewParamsBodyObjectRejectResourceType = "websocket" ScrapeNewParamsBodyObjectRejectResourceTypeManifest ScrapeNewParamsBodyObjectRejectResourceType = "manifest" ScrapeNewParamsBodyObjectRejectResourceTypeSignedexchange ScrapeNewParamsBodyObjectRejectResourceType = "signedexchange" ScrapeNewParamsBodyObjectRejectResourceTypePing ScrapeNewParamsBodyObjectRejectResourceType = "ping" ScrapeNewParamsBodyObjectRejectResourceTypeCspviolationreport ScrapeNewParamsBodyObjectRejectResourceType = "cspviolationreport" ScrapeNewParamsBodyObjectRejectResourceTypePreflight ScrapeNewParamsBodyObjectRejectResourceType = "preflight" ScrapeNewParamsBodyObjectRejectResourceTypeOther ScrapeNewParamsBodyObjectRejectResourceType = "other" )
func (ScrapeNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectRejectResourceType) IsKnown() bool
type ScrapeNewParamsBodyObjectViewport ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (ScrapeNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[ScrapeNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[ScrapeNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (ScrapeNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type ScrapeNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectWaitForSelectorHidden bool
const (
ScrapeNewParamsBodyObjectWaitForSelectorHiddenTrue ScrapeNewParamsBodyObjectWaitForSelectorHidden = true
)
func (ScrapeNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type ScrapeNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type ScrapeNewParamsBodyObjectWaitForSelectorVisible bool
const (
ScrapeNewParamsBodyObjectWaitForSelectorVisibleTrue ScrapeNewParamsBodyObjectWaitForSelectorVisible = true
)
func (ScrapeNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r ScrapeNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type ScrapeNewParamsBodyUnion ¶ added in v6.6.0
type ScrapeNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.ScrapeNewParamsBodyObject, browser_rendering.ScrapeNewParamsBodyObject, ScrapeNewParamsBody.
type ScrapeNewResponse ¶
type ScrapeNewResponse struct {
Results ScrapeNewResponseResults `json:"results,required"`
// Selector
Selector string `json:"selector,required"`
JSON scrapeNewResponseJSON `json:"-"`
}
func (*ScrapeNewResponse) UnmarshalJSON ¶
func (r *ScrapeNewResponse) UnmarshalJSON(data []byte) (err error)
type ScrapeNewResponseEnvelope ¶
type ScrapeNewResponseEnvelope struct {
Result []ScrapeNewResponse `json:"result,required"`
// Response status
Success bool `json:"success,required"`
Errors []ScrapeNewResponseEnvelopeErrors `json:"errors"`
JSON scrapeNewResponseEnvelopeJSON `json:"-"`
}
func (*ScrapeNewResponseEnvelope) UnmarshalJSON ¶
func (r *ScrapeNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ScrapeNewResponseEnvelopeErrors ¶
type ScrapeNewResponseEnvelopeErrors struct {
// Error code
Code float64 `json:"code,required"`
// Error Message
Message string `json:"message,required"`
JSON scrapeNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ScrapeNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ScrapeNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ScrapeNewResponseResults ¶
type ScrapeNewResponseResults struct {
Attributes []ScrapeNewResponseResultsAttribute `json:"attributes,required"`
// Element height
Height float64 `json:"height,required"`
// Html content
HTML string `json:"html,required"`
// Element left
Left float64 `json:"left,required"`
// Text content
Text string `json:"text,required"`
// Element top
Top float64 `json:"top,required"`
// Element width
Width float64 `json:"width,required"`
JSON scrapeNewResponseResultsJSON `json:"-"`
}
func (*ScrapeNewResponseResults) UnmarshalJSON ¶
func (r *ScrapeNewResponseResults) UnmarshalJSON(data []byte) (err error)
type ScrapeNewResponseResultsAttribute ¶
type ScrapeNewResponseResultsAttribute struct {
// Attribute name
Name string `json:"name,required"`
// Attribute value
Value string `json:"value,required"`
JSON scrapeNewResponseResultsAttributeJSON `json:"-"`
}
func (*ScrapeNewResponseResultsAttribute) UnmarshalJSON ¶
func (r *ScrapeNewResponseResultsAttribute) UnmarshalJSON(data []byte) (err error)
type ScrapeService ¶
type ScrapeService struct {
Options []option.RequestOption
}
ScrapeService 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 NewScrapeService method instead.
func NewScrapeService ¶
func NewScrapeService(opts ...option.RequestOption) (r *ScrapeService)
NewScrapeService 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 (*ScrapeService) New ¶
func (r *ScrapeService) New(ctx context.Context, params ScrapeNewParams, opts ...option.RequestOption) (res *[]ScrapeNewResponse, err error)
Get meta attributes like height, width, text and others of selected elements.
type ScreenshotNewParams ¶
type ScreenshotNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body ScreenshotNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (ScreenshotNewParams) MarshalJSON ¶
func (r ScreenshotNewParams) MarshalJSON() (data []byte, err error)
func (ScreenshotNewParams) URLQuery ¶
func (r ScreenshotNewParams) URLQuery() (v url.Values)
URLQuery serializes ScreenshotNewParams's query parameters as `url.Values`.
type ScreenshotNewParamsBody ¶ added in v6.6.0
type ScreenshotNewParamsBody struct {
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
ScreenshotOptions param.Field[interface{}] `json:"screenshotOptions"`
ScrollPage param.Field[bool] `json:"scrollPage"`
Selector param.Field[string] `json:"selector"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (ScreenshotNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBody) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObject ¶ added in v6.6.0
type ScreenshotNewParamsBodyObject struct {
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html,required"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]ScreenshotNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]ScreenshotNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]ScreenshotNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[ScreenshotNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]ScreenshotNewParamsBodyObjectCookie] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[ScreenshotNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]ScreenshotNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
// Check [options](https://pptr.dev/api/puppeteer.screenshotoptions).
ScreenshotOptions param.Field[ScreenshotNewParamsBodyObjectScreenshotOptions] `json:"screenshotOptions"`
ScrollPage param.Field[bool] `json:"scrollPage"`
Selector param.Field[string] `json:"selector"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[ScreenshotNewParamsBodyObjectViewport] `json:"viewport"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[ScreenshotNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (ScreenshotNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (ScreenshotNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (ScreenshotNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectAllowResourceType string
const ( ScreenshotNewParamsBodyObjectAllowResourceTypeDocument ScreenshotNewParamsBodyObjectAllowResourceType = "document" ScreenshotNewParamsBodyObjectAllowResourceTypeStylesheet ScreenshotNewParamsBodyObjectAllowResourceType = "stylesheet" ScreenshotNewParamsBodyObjectAllowResourceTypeImage ScreenshotNewParamsBodyObjectAllowResourceType = "image" ScreenshotNewParamsBodyObjectAllowResourceTypeMedia ScreenshotNewParamsBodyObjectAllowResourceType = "media" ScreenshotNewParamsBodyObjectAllowResourceTypeFont ScreenshotNewParamsBodyObjectAllowResourceType = "font" ScreenshotNewParamsBodyObjectAllowResourceTypeScript ScreenshotNewParamsBodyObjectAllowResourceType = "script" ScreenshotNewParamsBodyObjectAllowResourceTypeTexttrack ScreenshotNewParamsBodyObjectAllowResourceType = "texttrack" ScreenshotNewParamsBodyObjectAllowResourceTypeXHR ScreenshotNewParamsBodyObjectAllowResourceType = "xhr" ScreenshotNewParamsBodyObjectAllowResourceTypeFetch ScreenshotNewParamsBodyObjectAllowResourceType = "fetch" ScreenshotNewParamsBodyObjectAllowResourceTypePrefetch ScreenshotNewParamsBodyObjectAllowResourceType = "prefetch" ScreenshotNewParamsBodyObjectAllowResourceTypeEventsource ScreenshotNewParamsBodyObjectAllowResourceType = "eventsource" ScreenshotNewParamsBodyObjectAllowResourceTypeWebsocket ScreenshotNewParamsBodyObjectAllowResourceType = "websocket" ScreenshotNewParamsBodyObjectAllowResourceTypeManifest ScreenshotNewParamsBodyObjectAllowResourceType = "manifest" ScreenshotNewParamsBodyObjectAllowResourceTypeSignedexchange ScreenshotNewParamsBodyObjectAllowResourceType = "signedexchange" ScreenshotNewParamsBodyObjectAllowResourceTypePing ScreenshotNewParamsBodyObjectAllowResourceType = "ping" ScreenshotNewParamsBodyObjectAllowResourceTypeCspviolationreport ScreenshotNewParamsBodyObjectAllowResourceType = "cspviolationreport" ScreenshotNewParamsBodyObjectAllowResourceTypePreflight ScreenshotNewParamsBodyObjectAllowResourceType = "preflight" ScreenshotNewParamsBodyObjectAllowResourceTypeOther ScreenshotNewParamsBodyObjectAllowResourceType = "other" )
func (ScreenshotNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectAllowResourceType) IsKnown() bool
type ScreenshotNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (ScreenshotNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectCookie ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[ScreenshotNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[ScreenshotNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[ScreenshotNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (ScreenshotNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectCookiesPriority string
const ( ScreenshotNewParamsBodyObjectCookiesPriorityLow ScreenshotNewParamsBodyObjectCookiesPriority = "Low" ScreenshotNewParamsBodyObjectCookiesPriorityMedium ScreenshotNewParamsBodyObjectCookiesPriority = "Medium" ScreenshotNewParamsBodyObjectCookiesPriorityHigh ScreenshotNewParamsBodyObjectCookiesPriority = "High" )
func (ScreenshotNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectCookiesPriority) IsKnown() bool
type ScreenshotNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectCookiesSameSite string
const ( ScreenshotNewParamsBodyObjectCookiesSameSiteStrict ScreenshotNewParamsBodyObjectCookiesSameSite = "Strict" ScreenshotNewParamsBodyObjectCookiesSameSiteLax ScreenshotNewParamsBodyObjectCookiesSameSite = "Lax" ScreenshotNewParamsBodyObjectCookiesSameSiteNone ScreenshotNewParamsBodyObjectCookiesSameSite = "None" )
func (ScreenshotNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type ScreenshotNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectCookiesSourceScheme string
const ( ScreenshotNewParamsBodyObjectCookiesSourceSchemeUnset ScreenshotNewParamsBodyObjectCookiesSourceScheme = "Unset" ScreenshotNewParamsBodyObjectCookiesSourceSchemeNonSecure ScreenshotNewParamsBodyObjectCookiesSourceScheme = "NonSecure" ScreenshotNewParamsBodyObjectCookiesSourceSchemeSecure ScreenshotNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (ScreenshotNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type ScreenshotNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (ScreenshotNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArray []ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilStringLoad ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString = "load" ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.ScreenshotNewParamsBodyObjectGotoOptionsWaitUntilArray.
type ScreenshotNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectRejectResourceType string
const ( ScreenshotNewParamsBodyObjectRejectResourceTypeDocument ScreenshotNewParamsBodyObjectRejectResourceType = "document" ScreenshotNewParamsBodyObjectRejectResourceTypeStylesheet ScreenshotNewParamsBodyObjectRejectResourceType = "stylesheet" ScreenshotNewParamsBodyObjectRejectResourceTypeImage ScreenshotNewParamsBodyObjectRejectResourceType = "image" ScreenshotNewParamsBodyObjectRejectResourceTypeMedia ScreenshotNewParamsBodyObjectRejectResourceType = "media" ScreenshotNewParamsBodyObjectRejectResourceTypeFont ScreenshotNewParamsBodyObjectRejectResourceType = "font" ScreenshotNewParamsBodyObjectRejectResourceTypeScript ScreenshotNewParamsBodyObjectRejectResourceType = "script" ScreenshotNewParamsBodyObjectRejectResourceTypeTexttrack ScreenshotNewParamsBodyObjectRejectResourceType = "texttrack" ScreenshotNewParamsBodyObjectRejectResourceTypeXHR ScreenshotNewParamsBodyObjectRejectResourceType = "xhr" ScreenshotNewParamsBodyObjectRejectResourceTypeFetch ScreenshotNewParamsBodyObjectRejectResourceType = "fetch" ScreenshotNewParamsBodyObjectRejectResourceTypePrefetch ScreenshotNewParamsBodyObjectRejectResourceType = "prefetch" ScreenshotNewParamsBodyObjectRejectResourceTypeEventsource ScreenshotNewParamsBodyObjectRejectResourceType = "eventsource" ScreenshotNewParamsBodyObjectRejectResourceTypeWebsocket ScreenshotNewParamsBodyObjectRejectResourceType = "websocket" ScreenshotNewParamsBodyObjectRejectResourceTypeManifest ScreenshotNewParamsBodyObjectRejectResourceType = "manifest" ScreenshotNewParamsBodyObjectRejectResourceTypeSignedexchange ScreenshotNewParamsBodyObjectRejectResourceType = "signedexchange" ScreenshotNewParamsBodyObjectRejectResourceTypePing ScreenshotNewParamsBodyObjectRejectResourceType = "ping" ScreenshotNewParamsBodyObjectRejectResourceTypeCspviolationreport ScreenshotNewParamsBodyObjectRejectResourceType = "cspviolationreport" ScreenshotNewParamsBodyObjectRejectResourceTypePreflight ScreenshotNewParamsBodyObjectRejectResourceType = "preflight" ScreenshotNewParamsBodyObjectRejectResourceTypeOther ScreenshotNewParamsBodyObjectRejectResourceType = "other" )
func (ScreenshotNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectRejectResourceType) IsKnown() bool
type ScreenshotNewParamsBodyObjectScreenshotOptions ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectScreenshotOptions struct {
CaptureBeyondViewport param.Field[bool] `json:"captureBeyondViewport"`
Clip param.Field[ScreenshotNewParamsBodyObjectScreenshotOptionsClip] `json:"clip"`
Encoding param.Field[ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding] `json:"encoding"`
FromSurface param.Field[bool] `json:"fromSurface"`
FullPage param.Field[bool] `json:"fullPage"`
OmitBackground param.Field[bool] `json:"omitBackground"`
OptimizeForSpeed param.Field[bool] `json:"optimizeForSpeed"`
Quality param.Field[float64] `json:"quality"`
Type param.Field[ScreenshotNewParamsBodyObjectScreenshotOptionsType] `json:"type"`
}
Check [options](https://pptr.dev/api/puppeteer.screenshotoptions).
func (ScreenshotNewParamsBodyObjectScreenshotOptions) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectScreenshotOptions) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectScreenshotOptionsClip ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectScreenshotOptionsClip struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
X param.Field[float64] `json:"x,required"`
Y param.Field[float64] `json:"y,required"`
Scale param.Field[float64] `json:"scale"`
}
func (ScreenshotNewParamsBodyObjectScreenshotOptionsClip) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectScreenshotOptionsClip) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding string
const ( ScreenshotNewParamsBodyObjectScreenshotOptionsEncodingBinary ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding = "binary" ScreenshotNewParamsBodyObjectScreenshotOptionsEncodingBase64 ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding = "base64" )
func (ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectScreenshotOptionsEncoding) IsKnown() bool
type ScreenshotNewParamsBodyObjectScreenshotOptionsType ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectScreenshotOptionsType string
const ( ScreenshotNewParamsBodyObjectScreenshotOptionsTypePNG ScreenshotNewParamsBodyObjectScreenshotOptionsType = "png" ScreenshotNewParamsBodyObjectScreenshotOptionsTypeJPEG ScreenshotNewParamsBodyObjectScreenshotOptionsType = "jpeg" ScreenshotNewParamsBodyObjectScreenshotOptionsTypeWebP ScreenshotNewParamsBodyObjectScreenshotOptionsType = "webp" )
func (ScreenshotNewParamsBodyObjectScreenshotOptionsType) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectScreenshotOptionsType) IsKnown() bool
type ScreenshotNewParamsBodyObjectViewport ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (ScreenshotNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[ScreenshotNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[ScreenshotNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (ScreenshotNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type ScreenshotNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectWaitForSelectorHidden bool
const (
ScreenshotNewParamsBodyObjectWaitForSelectorHiddenTrue ScreenshotNewParamsBodyObjectWaitForSelectorHidden = true
)
func (ScreenshotNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type ScreenshotNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type ScreenshotNewParamsBodyObjectWaitForSelectorVisible bool
const (
ScreenshotNewParamsBodyObjectWaitForSelectorVisibleTrue ScreenshotNewParamsBodyObjectWaitForSelectorVisible = true
)
func (ScreenshotNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r ScreenshotNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type ScreenshotNewParamsBodyUnion ¶ added in v6.6.0
type ScreenshotNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.ScreenshotNewParamsBodyObject, browser_rendering.ScreenshotNewParamsBodyObject, ScreenshotNewParamsBody.
type ScreenshotNewResponse ¶
type ScreenshotNewResponse struct {
// Response status
Success bool `json:"success,required"`
Errors []ScreenshotNewResponseError `json:"errors"`
JSON screenshotNewResponseJSON `json:"-"`
}
func (*ScreenshotNewResponse) UnmarshalJSON ¶
func (r *ScreenshotNewResponse) UnmarshalJSON(data []byte) (err error)
type ScreenshotNewResponseError ¶
type ScreenshotNewResponseError struct {
// Error code
Code float64 `json:"code,required"`
// Error Message
Message string `json:"message,required"`
JSON screenshotNewResponseErrorJSON `json:"-"`
}
func (*ScreenshotNewResponseError) UnmarshalJSON ¶
func (r *ScreenshotNewResponseError) UnmarshalJSON(data []byte) (err error)
type ScreenshotService ¶
type ScreenshotService struct {
Options []option.RequestOption
}
ScreenshotService 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 NewScreenshotService method instead.
func NewScreenshotService ¶
func NewScreenshotService(opts ...option.RequestOption) (r *ScreenshotService)
NewScreenshotService 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 (*ScreenshotService) New ¶
func (r *ScreenshotService) New(ctx context.Context, params ScreenshotNewParams, opts ...option.RequestOption) (res *ScreenshotNewResponse, err error)
Takes a screenshot of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.
type SnapshotNewParams ¶
type SnapshotNewParams struct {
// Account ID.
AccountID param.Field[string] `path:"account_id,required"`
Body SnapshotNewParamsBodyUnion `json:"body,required"`
// Cache TTL default is 5s. Set to 0 to disable.
CacheTTL param.Field[float64] `query:"cacheTTL"`
}
func (SnapshotNewParams) MarshalJSON ¶
func (r SnapshotNewParams) MarshalJSON() (data []byte, err error)
func (SnapshotNewParams) URLQuery ¶
func (r SnapshotNewParams) URLQuery() (v url.Values)
URLQuery serializes SnapshotNewParams's query parameters as `url.Values`.
type SnapshotNewParamsBody ¶ added in v6.6.0
type SnapshotNewParamsBody struct {
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
AddScriptTag param.Field[interface{}] `json:"addScriptTag"`
AddStyleTag param.Field[interface{}] `json:"addStyleTag"`
AllowRequestPattern param.Field[interface{}] `json:"allowRequestPattern"`
AllowResourceTypes param.Field[interface{}] `json:"allowResourceTypes"`
Authenticate param.Field[interface{}] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
Cookies param.Field[interface{}] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
GotoOptions param.Field[interface{}] `json:"gotoOptions"`
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html"`
RejectRequestPattern param.Field[interface{}] `json:"rejectRequestPattern"`
RejectResourceTypes param.Field[interface{}] `json:"rejectResourceTypes"`
ScreenshotOptions param.Field[interface{}] `json:"screenshotOptions"`
SetExtraHTTPHeaders param.Field[interface{}] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
// URL to navigate to, eg. `https://example.com`.
URL param.Field[string] `json:"url" format:"uri"`
UserAgent param.Field[string] `json:"userAgent"`
Viewport param.Field[interface{}] `json:"viewport"`
WaitForSelector param.Field[interface{}] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (SnapshotNewParamsBody) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBody) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObject ¶ added in v6.6.0
type SnapshotNewParamsBodyObject struct {
// Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or
// `url` must be set.
HTML param.Field[string] `json:"html,required"`
// The maximum duration allowed for the browser action to complete after the page
// has loaded (such as taking screenshots, extracting content, or generating PDFs).
// If this time limit is exceeded, the action stops and returns a timeout error.
ActionTimeout param.Field[float64] `json:"actionTimeout"`
// Adds a `<script>` tag into the page with the desired URL or content.
AddScriptTag param.Field[[]SnapshotNewParamsBodyObjectAddScriptTag] `json:"addScriptTag"`
// Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a
// `<style type="text/css">` tag with the content.
AddStyleTag param.Field[[]SnapshotNewParamsBodyObjectAddStyleTag] `json:"addStyleTag"`
// Only allow requests that match the provided regex patterns, eg. '/^.\*\.(css)'.
AllowRequestPattern param.Field[[]string] `json:"allowRequestPattern"`
// Only allow requests that match the provided resource types, eg. 'image' or
// 'script'.
AllowResourceTypes param.Field[[]SnapshotNewParamsBodyObjectAllowResourceType] `json:"allowResourceTypes"`
// Provide credentials for HTTP authentication.
Authenticate param.Field[SnapshotNewParamsBodyObjectAuthenticate] `json:"authenticate"`
// Attempt to proceed when 'awaited' events fail or timeout.
BestAttempt param.Field[bool] `json:"bestAttempt"`
// Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
Cookies param.Field[[]SnapshotNewParamsBodyObjectCookie] `json:"cookies"`
EmulateMediaType param.Field[string] `json:"emulateMediaType"`
// Check [options](https://pptr.dev/api/puppeteer.gotooptions).
GotoOptions param.Field[SnapshotNewParamsBodyObjectGotoOptions] `json:"gotoOptions"`
// Block undesired requests that match the provided regex patterns, eg.
// '/^.\*\.(css)'.
RejectRequestPattern param.Field[[]string] `json:"rejectRequestPattern"`
// Block undesired requests that match the provided resource types, eg. 'image' or
// 'script'.
RejectResourceTypes param.Field[[]SnapshotNewParamsBodyObjectRejectResourceType] `json:"rejectResourceTypes"`
ScreenshotOptions param.Field[SnapshotNewParamsBodyObjectScreenshotOptions] `json:"screenshotOptions"`
SetExtraHTTPHeaders param.Field[map[string]string] `json:"setExtraHTTPHeaders"`
SetJavaScriptEnabled param.Field[bool] `json:"setJavaScriptEnabled"`
UserAgent param.Field[string] `json:"userAgent"`
// Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
Viewport param.Field[SnapshotNewParamsBodyObjectViewport] `json:"viewport"`
// Wait for the selector to appear in page. Check
// [options](https://pptr.dev/api/puppeteer.page.waitforselector).
WaitForSelector param.Field[SnapshotNewParamsBodyObjectWaitForSelector] `json:"waitForSelector"`
// Waits for a specified timeout before continuing.
WaitForTimeout param.Field[float64] `json:"waitForTimeout"`
}
func (SnapshotNewParamsBodyObject) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObject) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectAddScriptTag ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectAddScriptTag struct {
ID param.Field[string] `json:"id"`
Content param.Field[string] `json:"content"`
Type param.Field[string] `json:"type"`
URL param.Field[string] `json:"url"`
}
func (SnapshotNewParamsBodyObjectAddScriptTag) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectAddScriptTag) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectAddStyleTag ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectAddStyleTag struct {
Content param.Field[string] `json:"content"`
URL param.Field[string] `json:"url"`
}
func (SnapshotNewParamsBodyObjectAddStyleTag) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectAddStyleTag) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectAllowResourceType ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectAllowResourceType string
const ( SnapshotNewParamsBodyObjectAllowResourceTypeDocument SnapshotNewParamsBodyObjectAllowResourceType = "document" SnapshotNewParamsBodyObjectAllowResourceTypeStylesheet SnapshotNewParamsBodyObjectAllowResourceType = "stylesheet" SnapshotNewParamsBodyObjectAllowResourceTypeImage SnapshotNewParamsBodyObjectAllowResourceType = "image" SnapshotNewParamsBodyObjectAllowResourceTypeMedia SnapshotNewParamsBodyObjectAllowResourceType = "media" SnapshotNewParamsBodyObjectAllowResourceTypeFont SnapshotNewParamsBodyObjectAllowResourceType = "font" SnapshotNewParamsBodyObjectAllowResourceTypeScript SnapshotNewParamsBodyObjectAllowResourceType = "script" SnapshotNewParamsBodyObjectAllowResourceTypeTexttrack SnapshotNewParamsBodyObjectAllowResourceType = "texttrack" SnapshotNewParamsBodyObjectAllowResourceTypeXHR SnapshotNewParamsBodyObjectAllowResourceType = "xhr" SnapshotNewParamsBodyObjectAllowResourceTypeFetch SnapshotNewParamsBodyObjectAllowResourceType = "fetch" SnapshotNewParamsBodyObjectAllowResourceTypePrefetch SnapshotNewParamsBodyObjectAllowResourceType = "prefetch" SnapshotNewParamsBodyObjectAllowResourceTypeEventsource SnapshotNewParamsBodyObjectAllowResourceType = "eventsource" SnapshotNewParamsBodyObjectAllowResourceTypeWebsocket SnapshotNewParamsBodyObjectAllowResourceType = "websocket" SnapshotNewParamsBodyObjectAllowResourceTypeManifest SnapshotNewParamsBodyObjectAllowResourceType = "manifest" SnapshotNewParamsBodyObjectAllowResourceTypeSignedexchange SnapshotNewParamsBodyObjectAllowResourceType = "signedexchange" SnapshotNewParamsBodyObjectAllowResourceTypePing SnapshotNewParamsBodyObjectAllowResourceType = "ping" SnapshotNewParamsBodyObjectAllowResourceTypeCspviolationreport SnapshotNewParamsBodyObjectAllowResourceType = "cspviolationreport" SnapshotNewParamsBodyObjectAllowResourceTypePreflight SnapshotNewParamsBodyObjectAllowResourceType = "preflight" SnapshotNewParamsBodyObjectAllowResourceTypeOther SnapshotNewParamsBodyObjectAllowResourceType = "other" )
func (SnapshotNewParamsBodyObjectAllowResourceType) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectAllowResourceType) IsKnown() bool
type SnapshotNewParamsBodyObjectAuthenticate ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectAuthenticate struct {
Password param.Field[string] `json:"password,required"`
Username param.Field[string] `json:"username,required"`
}
Provide credentials for HTTP authentication.
func (SnapshotNewParamsBodyObjectAuthenticate) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectAuthenticate) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectCookie ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectCookie struct {
Name param.Field[string] `json:"name,required"`
Value param.Field[string] `json:"value,required"`
Domain param.Field[string] `json:"domain"`
Expires param.Field[float64] `json:"expires"`
HTTPOnly param.Field[bool] `json:"httpOnly"`
PartitionKey param.Field[string] `json:"partitionKey"`
Path param.Field[string] `json:"path"`
Priority param.Field[SnapshotNewParamsBodyObjectCookiesPriority] `json:"priority"`
SameParty param.Field[bool] `json:"sameParty"`
SameSite param.Field[SnapshotNewParamsBodyObjectCookiesSameSite] `json:"sameSite"`
Secure param.Field[bool] `json:"secure"`
SourcePort param.Field[float64] `json:"sourcePort"`
SourceScheme param.Field[SnapshotNewParamsBodyObjectCookiesSourceScheme] `json:"sourceScheme"`
URL param.Field[string] `json:"url"`
}
func (SnapshotNewParamsBodyObjectCookie) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectCookie) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectCookiesPriority ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectCookiesPriority string
const ( SnapshotNewParamsBodyObjectCookiesPriorityLow SnapshotNewParamsBodyObjectCookiesPriority = "Low" SnapshotNewParamsBodyObjectCookiesPriorityMedium SnapshotNewParamsBodyObjectCookiesPriority = "Medium" SnapshotNewParamsBodyObjectCookiesPriorityHigh SnapshotNewParamsBodyObjectCookiesPriority = "High" )
func (SnapshotNewParamsBodyObjectCookiesPriority) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectCookiesPriority) IsKnown() bool
type SnapshotNewParamsBodyObjectCookiesSameSite ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectCookiesSameSite string
const ( SnapshotNewParamsBodyObjectCookiesSameSiteStrict SnapshotNewParamsBodyObjectCookiesSameSite = "Strict" SnapshotNewParamsBodyObjectCookiesSameSiteLax SnapshotNewParamsBodyObjectCookiesSameSite = "Lax" SnapshotNewParamsBodyObjectCookiesSameSiteNone SnapshotNewParamsBodyObjectCookiesSameSite = "None" )
func (SnapshotNewParamsBodyObjectCookiesSameSite) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectCookiesSameSite) IsKnown() bool
type SnapshotNewParamsBodyObjectCookiesSourceScheme ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectCookiesSourceScheme string
const ( SnapshotNewParamsBodyObjectCookiesSourceSchemeUnset SnapshotNewParamsBodyObjectCookiesSourceScheme = "Unset" SnapshotNewParamsBodyObjectCookiesSourceSchemeNonSecure SnapshotNewParamsBodyObjectCookiesSourceScheme = "NonSecure" SnapshotNewParamsBodyObjectCookiesSourceSchemeSecure SnapshotNewParamsBodyObjectCookiesSourceScheme = "Secure" )
func (SnapshotNewParamsBodyObjectCookiesSourceScheme) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectCookiesSourceScheme) IsKnown() bool
type SnapshotNewParamsBodyObjectGotoOptions ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectGotoOptions struct {
Referer param.Field[string] `json:"referer"`
ReferrerPolicy param.Field[string] `json:"referrerPolicy"`
Timeout param.Field[float64] `json:"timeout"`
WaitUntil param.Field[SnapshotNewParamsBodyObjectGotoOptionsWaitUntilUnion] `json:"waitUntil"`
}
Check [options](https://pptr.dev/api/puppeteer.gotooptions).
func (SnapshotNewParamsBodyObjectGotoOptions) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectGotoOptions) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArray ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArray []SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem string
const ( SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemLoad SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "load" SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemDomcontentloaded SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "domcontentloaded" SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle0 SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle0" SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItemNetworkidle2 SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem = "networkidle2" )
func (SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArrayItem) IsKnown() bool
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString string
const ( SnapshotNewParamsBodyObjectGotoOptionsWaitUntilStringLoad SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString = "load" SnapshotNewParamsBodyObjectGotoOptionsWaitUntilStringDomcontentloaded SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString = "domcontentloaded" SnapshotNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle0 SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle0" SnapshotNewParamsBodyObjectGotoOptionsWaitUntilStringNetworkidle2 SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString = "networkidle2" )
func (SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString) IsKnown() bool
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilUnion ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectGotoOptionsWaitUntilUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.SnapshotNewParamsBodyObjectGotoOptionsWaitUntilString, browser_rendering.SnapshotNewParamsBodyObjectGotoOptionsWaitUntilArray.
type SnapshotNewParamsBodyObjectRejectResourceType ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectRejectResourceType string
const ( SnapshotNewParamsBodyObjectRejectResourceTypeDocument SnapshotNewParamsBodyObjectRejectResourceType = "document" SnapshotNewParamsBodyObjectRejectResourceTypeStylesheet SnapshotNewParamsBodyObjectRejectResourceType = "stylesheet" SnapshotNewParamsBodyObjectRejectResourceTypeImage SnapshotNewParamsBodyObjectRejectResourceType = "image" SnapshotNewParamsBodyObjectRejectResourceTypeMedia SnapshotNewParamsBodyObjectRejectResourceType = "media" SnapshotNewParamsBodyObjectRejectResourceTypeFont SnapshotNewParamsBodyObjectRejectResourceType = "font" SnapshotNewParamsBodyObjectRejectResourceTypeScript SnapshotNewParamsBodyObjectRejectResourceType = "script" SnapshotNewParamsBodyObjectRejectResourceTypeTexttrack SnapshotNewParamsBodyObjectRejectResourceType = "texttrack" SnapshotNewParamsBodyObjectRejectResourceTypeXHR SnapshotNewParamsBodyObjectRejectResourceType = "xhr" SnapshotNewParamsBodyObjectRejectResourceTypeFetch SnapshotNewParamsBodyObjectRejectResourceType = "fetch" SnapshotNewParamsBodyObjectRejectResourceTypePrefetch SnapshotNewParamsBodyObjectRejectResourceType = "prefetch" SnapshotNewParamsBodyObjectRejectResourceTypeEventsource SnapshotNewParamsBodyObjectRejectResourceType = "eventsource" SnapshotNewParamsBodyObjectRejectResourceTypeWebsocket SnapshotNewParamsBodyObjectRejectResourceType = "websocket" SnapshotNewParamsBodyObjectRejectResourceTypeManifest SnapshotNewParamsBodyObjectRejectResourceType = "manifest" SnapshotNewParamsBodyObjectRejectResourceTypeSignedexchange SnapshotNewParamsBodyObjectRejectResourceType = "signedexchange" SnapshotNewParamsBodyObjectRejectResourceTypePing SnapshotNewParamsBodyObjectRejectResourceType = "ping" SnapshotNewParamsBodyObjectRejectResourceTypeCspviolationreport SnapshotNewParamsBodyObjectRejectResourceType = "cspviolationreport" SnapshotNewParamsBodyObjectRejectResourceTypePreflight SnapshotNewParamsBodyObjectRejectResourceType = "preflight" SnapshotNewParamsBodyObjectRejectResourceTypeOther SnapshotNewParamsBodyObjectRejectResourceType = "other" )
func (SnapshotNewParamsBodyObjectRejectResourceType) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectRejectResourceType) IsKnown() bool
type SnapshotNewParamsBodyObjectScreenshotOptions ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectScreenshotOptions struct {
CaptureBeyondViewport param.Field[bool] `json:"captureBeyondViewport"`
Clip param.Field[SnapshotNewParamsBodyObjectScreenshotOptionsClip] `json:"clip"`
FromSurface param.Field[bool] `json:"fromSurface"`
FullPage param.Field[bool] `json:"fullPage"`
OmitBackground param.Field[bool] `json:"omitBackground"`
OptimizeForSpeed param.Field[bool] `json:"optimizeForSpeed"`
Quality param.Field[float64] `json:"quality"`
Type param.Field[SnapshotNewParamsBodyObjectScreenshotOptionsType] `json:"type"`
}
func (SnapshotNewParamsBodyObjectScreenshotOptions) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectScreenshotOptions) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectScreenshotOptionsClip ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectScreenshotOptionsClip struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
X param.Field[float64] `json:"x,required"`
Y param.Field[float64] `json:"y,required"`
Scale param.Field[float64] `json:"scale"`
}
func (SnapshotNewParamsBodyObjectScreenshotOptionsClip) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectScreenshotOptionsClip) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectScreenshotOptionsType ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectScreenshotOptionsType string
const ( SnapshotNewParamsBodyObjectScreenshotOptionsTypePNG SnapshotNewParamsBodyObjectScreenshotOptionsType = "png" SnapshotNewParamsBodyObjectScreenshotOptionsTypeJPEG SnapshotNewParamsBodyObjectScreenshotOptionsType = "jpeg" SnapshotNewParamsBodyObjectScreenshotOptionsTypeWebP SnapshotNewParamsBodyObjectScreenshotOptionsType = "webp" )
func (SnapshotNewParamsBodyObjectScreenshotOptionsType) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectScreenshotOptionsType) IsKnown() bool
type SnapshotNewParamsBodyObjectViewport ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectViewport struct {
Height param.Field[float64] `json:"height,required"`
Width param.Field[float64] `json:"width,required"`
DeviceScaleFactor param.Field[float64] `json:"deviceScaleFactor"`
HasTouch param.Field[bool] `json:"hasTouch"`
IsLandscape param.Field[bool] `json:"isLandscape"`
IsMobile param.Field[bool] `json:"isMobile"`
}
Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
func (SnapshotNewParamsBodyObjectViewport) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectViewport) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectWaitForSelector ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectWaitForSelector struct {
Selector param.Field[string] `json:"selector,required"`
Hidden param.Field[SnapshotNewParamsBodyObjectWaitForSelectorHidden] `json:"hidden"`
Timeout param.Field[float64] `json:"timeout"`
Visible param.Field[SnapshotNewParamsBodyObjectWaitForSelectorVisible] `json:"visible"`
}
Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).
func (SnapshotNewParamsBodyObjectWaitForSelector) MarshalJSON ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectWaitForSelector) MarshalJSON() (data []byte, err error)
type SnapshotNewParamsBodyObjectWaitForSelectorHidden ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectWaitForSelectorHidden bool
const (
SnapshotNewParamsBodyObjectWaitForSelectorHiddenTrue SnapshotNewParamsBodyObjectWaitForSelectorHidden = true
)
func (SnapshotNewParamsBodyObjectWaitForSelectorHidden) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectWaitForSelectorHidden) IsKnown() bool
type SnapshotNewParamsBodyObjectWaitForSelectorVisible ¶ added in v6.6.0
type SnapshotNewParamsBodyObjectWaitForSelectorVisible bool
const (
SnapshotNewParamsBodyObjectWaitForSelectorVisibleTrue SnapshotNewParamsBodyObjectWaitForSelectorVisible = true
)
func (SnapshotNewParamsBodyObjectWaitForSelectorVisible) IsKnown ¶ added in v6.6.0
func (r SnapshotNewParamsBodyObjectWaitForSelectorVisible) IsKnown() bool
type SnapshotNewParamsBodyUnion ¶ added in v6.6.0
type SnapshotNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by browser_rendering.SnapshotNewParamsBodyObject, browser_rendering.SnapshotNewParamsBodyObject, SnapshotNewParamsBody.
type SnapshotNewResponse ¶
type SnapshotNewResponse struct {
// HTML content
Content string `json:"content,required"`
// Base64 encoded image
Screenshot string `json:"screenshot,required"`
JSON snapshotNewResponseJSON `json:"-"`
}
func (*SnapshotNewResponse) UnmarshalJSON ¶
func (r *SnapshotNewResponse) UnmarshalJSON(data []byte) (err error)
type SnapshotNewResponseEnvelope ¶
type SnapshotNewResponseEnvelope struct {
Meta SnapshotNewResponseEnvelopeMeta `json:"meta,required"`
// Response status
Success bool `json:"success,required"`
Errors []SnapshotNewResponseEnvelopeErrors `json:"errors"`
Result SnapshotNewResponse `json:"result"`
JSON snapshotNewResponseEnvelopeJSON `json:"-"`
}
func (*SnapshotNewResponseEnvelope) UnmarshalJSON ¶
func (r *SnapshotNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SnapshotNewResponseEnvelopeErrors ¶
type SnapshotNewResponseEnvelopeErrors struct {
// Error code
Code float64 `json:"code,required"`
// Error Message
Message string `json:"message,required"`
JSON snapshotNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*SnapshotNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SnapshotNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SnapshotNewResponseEnvelopeMeta ¶ added in v6.4.0
type SnapshotNewResponseEnvelopeMeta struct {
Status float64 `json:"status"`
Title string `json:"title"`
JSON snapshotNewResponseEnvelopeMetaJSON `json:"-"`
}
func (*SnapshotNewResponseEnvelopeMeta) UnmarshalJSON ¶ added in v6.4.0
func (r *SnapshotNewResponseEnvelopeMeta) UnmarshalJSON(data []byte) (err error)
type SnapshotService ¶
type SnapshotService struct {
Options []option.RequestOption
}
SnapshotService 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 NewSnapshotService method instead.
func NewSnapshotService ¶
func NewSnapshotService(opts ...option.RequestOption) (r *SnapshotService)
NewSnapshotService 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 (*SnapshotService) New ¶
func (r *SnapshotService) New(ctx context.Context, params SnapshotNewParams, opts ...option.RequestOption) (res *SnapshotNewResponse, err error)
Returns the page's HTML content and screenshot. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.