Documentation ¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type Bucket
- type BucketDeleteParams
- type BucketDeleteResponse
- type BucketDeleteResponseEnvelope
- type BucketDeleteResponseEnvelopeSuccess
- type BucketGetParams
- type BucketGetResponseEnvelope
- type BucketGetResponseEnvelopeSuccess
- type BucketListParams
- type BucketListParamsDirection
- type BucketListParamsOrder
- type BucketLocation
- type BucketNewParams
- type BucketNewParamsLocationHint
- type BucketNewResponseEnvelope
- type BucketNewResponseEnvelopeSuccess
- type BucketService
- func (r *BucketService) Delete(ctx context.Context, bucketName string, body BucketDeleteParams, ...) (res *BucketDeleteResponse, err error)
- func (r *BucketService) Get(ctx context.Context, bucketName string, query BucketGetParams, ...) (res *Bucket, err error)
- func (r *BucketService) List(ctx context.Context, params BucketListParams, opts ...option.RequestOption) (res *pagination.CursorPagination[Bucket], err error)
- func (r *BucketService) ListAutoPaging(ctx context.Context, params BucketListParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[Bucket]
- func (r *BucketService) New(ctx context.Context, params BucketNewParams, opts ...option.RequestOption) (res *Bucket, err error)
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type Member
- type MemberParam
- type MemberRole
- type MemberRoleParam
- type MemberRolesPermissions
- type MemberRolesPermissionsParam
- type MemberUser
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type Provider
- type R2Service
- type ResponseInfo
- type Role
- type Sippy
- type SippyDeleteParams
- type SippyDeleteResponse
- type SippyDeleteResponseEnabled
- type SippyDeleteResponseEnvelope
- type SippyDeleteResponseEnvelopeSuccess
- type SippyDestination
- type SippyGetParams
- type SippyGetResponseEnvelope
- type SippyGetResponseEnvelopeSuccess
- type SippyService
- func (r *SippyService) Delete(ctx context.Context, bucketName string, body SippyDeleteParams, ...) (res *SippyDeleteResponse, err error)
- func (r *SippyService) Get(ctx context.Context, bucketName string, query SippyGetParams, ...) (res *Sippy, err error)
- func (r *SippyService) Update(ctx context.Context, bucketName string, params SippyUpdateParams, ...) (res *Sippy, err error)
- type SippySource
- type SippySourceProvider
- type SippyUpdateParams
- type SippyUpdateParamsBody
- type SippyUpdateParamsBodyR2EnableSippyAws
- type SippyUpdateParamsBodyR2EnableSippyAwsDestination
- type SippyUpdateParamsBodyR2EnableSippyAwsSource
- type SippyUpdateParamsBodyR2EnableSippyAwsSourceProvider
- type SippyUpdateParamsBodyR2EnableSippyGcs
- type SippyUpdateParamsBodyR2EnableSippyGcsDestination
- type SippyUpdateParamsBodyR2EnableSippyGcsSource
- type SippyUpdateParamsBodyR2EnableSippyGcsSourceProvider
- type SippyUpdateParamsBodyUnion
- type SippyUpdateResponseEnvelope
- type SippyUpdateResponseEnvelopeSuccess
- type SortDirection
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 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 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
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.
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 Bucket ¶
type Bucket struct { // Creation timestamp CreationDate string `json:"creation_date"` // Location of the bucket Location BucketLocation `json:"location"` // Name of the bucket Name string `json:"name"` JSON bucketJSON `json:"-"` }
A single R2 bucket
func (*Bucket) UnmarshalJSON ¶
type BucketDeleteParams ¶
type BucketDeleteResponse ¶
type BucketDeleteResponse = interface{}
type BucketDeleteResponseEnvelope ¶
type BucketDeleteResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []string `json:"messages,required"` Result BucketDeleteResponse `json:"result,required"` // Whether the API call was successful Success BucketDeleteResponseEnvelopeSuccess `json:"success,required"` JSON bucketDeleteResponseEnvelopeJSON `json:"-"` }
func (*BucketDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *BucketDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BucketDeleteResponseEnvelopeSuccess ¶
type BucketDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
BucketDeleteResponseEnvelopeSuccessTrue BucketDeleteResponseEnvelopeSuccess = true
)
func (BucketDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r BucketDeleteResponseEnvelopeSuccess) IsKnown() bool
type BucketGetParams ¶
type BucketGetResponseEnvelope ¶
type BucketGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []string `json:"messages,required"` // A single R2 bucket Result Bucket `json:"result,required"` // Whether the API call was successful Success BucketGetResponseEnvelopeSuccess `json:"success,required"` JSON bucketGetResponseEnvelopeJSON `json:"-"` }
func (*BucketGetResponseEnvelope) UnmarshalJSON ¶
func (r *BucketGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BucketGetResponseEnvelopeSuccess ¶
type BucketGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
BucketGetResponseEnvelopeSuccessTrue BucketGetResponseEnvelopeSuccess = true
)
func (BucketGetResponseEnvelopeSuccess) IsKnown ¶
func (r BucketGetResponseEnvelopeSuccess) IsKnown() bool
type BucketListParams ¶
type BucketListParams struct { // Account ID AccountID param.Field[string] `path:"account_id,required"` // Pagination cursor received during the last List Buckets call. R2 buckets are // paginated using cursors instead of page numbers. Cursor param.Field[string] `query:"cursor"` // Direction to order buckets Direction param.Field[BucketListParamsDirection] `query:"direction"` // Bucket names to filter by. Only buckets with this phrase in their name will be // returned. NameContains param.Field[string] `query:"name_contains"` // Field to order buckets by Order param.Field[BucketListParamsOrder] `query:"order"` // Maximum number of buckets to return in a single call PerPage param.Field[float64] `query:"per_page"` // Bucket name to start searching after. Buckets are ordered lexicographically. StartAfter param.Field[string] `query:"start_after"` }
func (BucketListParams) URLQuery ¶
func (r BucketListParams) URLQuery() (v url.Values)
URLQuery serializes BucketListParams's query parameters as `url.Values`.
type BucketListParamsDirection ¶
type BucketListParamsDirection string
Direction to order buckets
const ( BucketListParamsDirectionAsc BucketListParamsDirection = "asc" BucketListParamsDirectionDesc BucketListParamsDirection = "desc" )
func (BucketListParamsDirection) IsKnown ¶
func (r BucketListParamsDirection) IsKnown() bool
type BucketListParamsOrder ¶
type BucketListParamsOrder string
Field to order buckets by
const (
BucketListParamsOrderName BucketListParamsOrder = "name"
)
func (BucketListParamsOrder) IsKnown ¶
func (r BucketListParamsOrder) IsKnown() bool
type BucketLocation ¶
type BucketLocation string
Location of the bucket
const ( BucketLocationApac BucketLocation = "apac" BucketLocationEeur BucketLocation = "eeur" BucketLocationEnam BucketLocation = "enam" BucketLocationWeur BucketLocation = "weur" BucketLocationWnam BucketLocation = "wnam" )
func (BucketLocation) IsKnown ¶
func (r BucketLocation) IsKnown() bool
type BucketNewParams ¶
type BucketNewParams struct { // Account ID AccountID param.Field[string] `path:"account_id,required"` // Name of the bucket Name param.Field[string] `json:"name,required"` // Location of the bucket LocationHint param.Field[BucketNewParamsLocationHint] `json:"locationHint"` }
func (BucketNewParams) MarshalJSON ¶
func (r BucketNewParams) MarshalJSON() (data []byte, err error)
type BucketNewParamsLocationHint ¶
type BucketNewParamsLocationHint string
Location of the bucket
const ( BucketNewParamsLocationHintApac BucketNewParamsLocationHint = "apac" BucketNewParamsLocationHintEeur BucketNewParamsLocationHint = "eeur" BucketNewParamsLocationHintEnam BucketNewParamsLocationHint = "enam" BucketNewParamsLocationHintWeur BucketNewParamsLocationHint = "weur" BucketNewParamsLocationHintWnam BucketNewParamsLocationHint = "wnam" )
func (BucketNewParamsLocationHint) IsKnown ¶
func (r BucketNewParamsLocationHint) IsKnown() bool
type BucketNewResponseEnvelope ¶
type BucketNewResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []string `json:"messages,required"` // A single R2 bucket Result Bucket `json:"result,required"` // Whether the API call was successful Success BucketNewResponseEnvelopeSuccess `json:"success,required"` JSON bucketNewResponseEnvelopeJSON `json:"-"` }
func (*BucketNewResponseEnvelope) UnmarshalJSON ¶
func (r *BucketNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BucketNewResponseEnvelopeSuccess ¶
type BucketNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
BucketNewResponseEnvelopeSuccessTrue BucketNewResponseEnvelopeSuccess = true
)
func (BucketNewResponseEnvelopeSuccess) IsKnown ¶
func (r BucketNewResponseEnvelopeSuccess) IsKnown() bool
type BucketService ¶
type BucketService struct {
Options []option.RequestOption
}
BucketService 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 NewBucketService method instead.
func NewBucketService ¶
func NewBucketService(opts ...option.RequestOption) (r *BucketService)
NewBucketService 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 (*BucketService) Delete ¶
func (r *BucketService) Delete(ctx context.Context, bucketName string, body BucketDeleteParams, opts ...option.RequestOption) (res *BucketDeleteResponse, err error)
Deletes an existing R2 bucket.
func (*BucketService) Get ¶
func (r *BucketService) Get(ctx context.Context, bucketName string, query BucketGetParams, opts ...option.RequestOption) (res *Bucket, err error)
Gets metadata for an existing R2 bucket.
func (*BucketService) List ¶
func (r *BucketService) List(ctx context.Context, params BucketListParams, opts ...option.RequestOption) (res *pagination.CursorPagination[Bucket], err error)
Lists all R2 buckets on your account
func (*BucketService) ListAutoPaging ¶
func (r *BucketService) ListAutoPaging(ctx context.Context, params BucketListParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[Bucket]
Lists all R2 buckets on your account
func (*BucketService) New ¶
func (r *BucketService) New(ctx context.Context, params BucketNewParams, opts ...option.RequestOption) (res *Bucket, err error)
Creates a new R2 bucket.
type CertificateCA ¶ added in v2.2.0
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶ added in v2.2.0
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type MemberParam ¶ added in v2.1.0
type MemberParam = shared.MemberParam
This is an alias to an internal type.
type MemberRole ¶ added in v2.1.0
type MemberRole = shared.MemberRole
This is an alias to an internal type.
type MemberRoleParam ¶ added in v2.1.0
type MemberRoleParam = shared.MemberRoleParam
This is an alias to an internal type.
type MemberRolesPermissions ¶ added in v2.1.0
type MemberRolesPermissions = shared.MemberRolesPermissions
This is an alias to an internal type.
type MemberRolesPermissionsParam ¶ added in v2.1.0
type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam
This is an alias to an internal type.
type MemberUser ¶ added in v2.1.0
type MemberUser = shared.MemberUser
This is an alias to an internal type.
type MemberUserParam ¶ added in v2.1.0
type MemberUserParam = shared.MemberUserParam
This is an alias to an internal type.
type PermissionGrant ¶
type PermissionGrant = shared.PermissionGrant
This is an alias to an internal type.
type PermissionGrantParam ¶
type PermissionGrantParam = shared.PermissionGrantParam
This is an alias to an internal type.
type R2Service ¶
type R2Service struct { Options []option.RequestOption Buckets *BucketService Sippy *SippyService }
R2Service contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewR2Service method instead.
func NewR2Service ¶
func NewR2Service(opts ...option.RequestOption) (r *R2Service)
NewR2Service generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
type Sippy ¶
type Sippy struct { // Details about the configured destination bucket Destination SippyDestination `json:"destination"` // State of Sippy for this bucket Enabled bool `json:"enabled"` // Details about the configured source bucket Source SippySource `json:"source"` JSON sippyJSON `json:"-"` }
func (*Sippy) UnmarshalJSON ¶
type SippyDeleteParams ¶
type SippyDeleteResponse ¶
type SippyDeleteResponse struct { Enabled SippyDeleteResponseEnabled `json:"enabled"` JSON sippyDeleteResponseJSON `json:"-"` }
func (*SippyDeleteResponse) UnmarshalJSON ¶
func (r *SippyDeleteResponse) UnmarshalJSON(data []byte) (err error)
type SippyDeleteResponseEnabled ¶
type SippyDeleteResponseEnabled bool
const (
SippyDeleteResponseEnabledFalse SippyDeleteResponseEnabled = false
)
func (SippyDeleteResponseEnabled) IsKnown ¶
func (r SippyDeleteResponseEnabled) IsKnown() bool
type SippyDeleteResponseEnvelope ¶
type SippyDeleteResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []string `json:"messages,required"` Result SippyDeleteResponse `json:"result,required"` // Whether the API call was successful Success SippyDeleteResponseEnvelopeSuccess `json:"success,required"` JSON sippyDeleteResponseEnvelopeJSON `json:"-"` }
func (*SippyDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SippyDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SippyDeleteResponseEnvelopeSuccess ¶
type SippyDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SippyDeleteResponseEnvelopeSuccessTrue SippyDeleteResponseEnvelopeSuccess = true
)
func (SippyDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SippyDeleteResponseEnvelopeSuccess) IsKnown() bool
type SippyDestination ¶
type SippyDestination struct { // ID of the Cloudflare API token used when writing objects to this bucket AccessKeyID string `json:"accessKeyId"` Account string `json:"account"` // Name of the bucket on the provider Bucket string `json:"bucket"` Provider Provider `json:"provider"` JSON sippyDestinationJSON `json:"-"` }
Details about the configured destination bucket
func (*SippyDestination) UnmarshalJSON ¶
func (r *SippyDestination) UnmarshalJSON(data []byte) (err error)
type SippyGetParams ¶
type SippyGetResponseEnvelope ¶
type SippyGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []string `json:"messages,required"` Result Sippy `json:"result,required"` // Whether the API call was successful Success SippyGetResponseEnvelopeSuccess `json:"success,required"` JSON sippyGetResponseEnvelopeJSON `json:"-"` }
func (*SippyGetResponseEnvelope) UnmarshalJSON ¶
func (r *SippyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SippyGetResponseEnvelopeSuccess ¶
type SippyGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SippyGetResponseEnvelopeSuccessTrue SippyGetResponseEnvelopeSuccess = true
)
func (SippyGetResponseEnvelopeSuccess) IsKnown ¶
func (r SippyGetResponseEnvelopeSuccess) IsKnown() bool
type SippyService ¶
type SippyService struct {
Options []option.RequestOption
}
SippyService 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 NewSippyService method instead.
func NewSippyService ¶
func NewSippyService(opts ...option.RequestOption) (r *SippyService)
NewSippyService 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 (*SippyService) Delete ¶
func (r *SippyService) Delete(ctx context.Context, bucketName string, body SippyDeleteParams, opts ...option.RequestOption) (res *SippyDeleteResponse, err error)
Disables Sippy on this bucket
func (*SippyService) Get ¶
func (r *SippyService) Get(ctx context.Context, bucketName string, query SippyGetParams, opts ...option.RequestOption) (res *Sippy, err error)
Gets configuration for Sippy for an existing R2 bucket.
func (*SippyService) Update ¶
func (r *SippyService) Update(ctx context.Context, bucketName string, params SippyUpdateParams, opts ...option.RequestOption) (res *Sippy, err error)
Sets configuration for Sippy for an existing R2 bucket.
type SippySource ¶
type SippySource struct { // Name of the bucket on the provider Bucket string `json:"bucket"` Provider SippySourceProvider `json:"provider"` // Region where the bucket resides (AWS only) Region string `json:"region,nullable"` JSON sippySourceJSON `json:"-"` }
Details about the configured source bucket
func (*SippySource) UnmarshalJSON ¶
func (r *SippySource) UnmarshalJSON(data []byte) (err error)
type SippySourceProvider ¶
type SippySourceProvider string
const ( SippySourceProviderAws SippySourceProvider = "aws" SippySourceProviderGcs SippySourceProvider = "gcs" )
func (SippySourceProvider) IsKnown ¶
func (r SippySourceProvider) IsKnown() bool
type SippyUpdateParams ¶
type SippyUpdateParams struct { // Account ID AccountID param.Field[string] `path:"account_id,required"` Body SippyUpdateParamsBodyUnion `json:"body,required"` }
func (SippyUpdateParams) MarshalJSON ¶
func (r SippyUpdateParams) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBody ¶
type SippyUpdateParamsBody struct { Destination param.Field[interface{}] `json:"destination,required"` Source param.Field[interface{}] `json:"source,required"` }
func (SippyUpdateParamsBody) MarshalJSON ¶
func (r SippyUpdateParamsBody) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBodyR2EnableSippyAws ¶
type SippyUpdateParamsBodyR2EnableSippyAws struct { // R2 bucket to copy objects to Destination param.Field[SippyUpdateParamsBodyR2EnableSippyAwsDestination] `json:"destination"` // AWS S3 bucket to copy objects from Source param.Field[SippyUpdateParamsBodyR2EnableSippyAwsSource] `json:"source"` }
func (SippyUpdateParamsBodyR2EnableSippyAws) MarshalJSON ¶
func (r SippyUpdateParamsBodyR2EnableSippyAws) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBodyR2EnableSippyAwsDestination ¶
type SippyUpdateParamsBodyR2EnableSippyAwsDestination struct { // ID of a Cloudflare API token. This is the value labelled "Access Key ID" when // creating an API token from the // [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens). // // Sippy will use this token when writing objects to R2, so it is best to scope // this token to the bucket you're enabling Sippy for. AccessKeyID param.Field[string] `json:"accessKeyId"` Provider param.Field[Provider] `json:"provider"` // Value of a Cloudflare API token. This is the value labelled "Secret Access Key" // when creating an API token from the // [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens). // // Sippy will use this token when writing objects to R2, so it is best to scope // this token to the bucket you're enabling Sippy for. SecretAccessKey param.Field[string] `json:"secretAccessKey"` }
R2 bucket to copy objects to
func (SippyUpdateParamsBodyR2EnableSippyAwsDestination) MarshalJSON ¶
func (r SippyUpdateParamsBodyR2EnableSippyAwsDestination) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBodyR2EnableSippyAwsSource ¶
type SippyUpdateParamsBodyR2EnableSippyAwsSource struct { // Access Key ID of an IAM credential (ideally scoped to a single S3 bucket) AccessKeyID param.Field[string] `json:"accessKeyId"` // Name of the AWS S3 bucket Bucket param.Field[string] `json:"bucket"` Provider param.Field[SippyUpdateParamsBodyR2EnableSippyAwsSourceProvider] `json:"provider"` // Name of the AWS availability zone Region param.Field[string] `json:"region"` // Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket) SecretAccessKey param.Field[string] `json:"secretAccessKey"` }
AWS S3 bucket to copy objects from
func (SippyUpdateParamsBodyR2EnableSippyAwsSource) MarshalJSON ¶
func (r SippyUpdateParamsBodyR2EnableSippyAwsSource) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBodyR2EnableSippyAwsSourceProvider ¶
type SippyUpdateParamsBodyR2EnableSippyAwsSourceProvider string
const (
SippyUpdateParamsBodyR2EnableSippyAwsSourceProviderAws SippyUpdateParamsBodyR2EnableSippyAwsSourceProvider = "aws"
)
func (SippyUpdateParamsBodyR2EnableSippyAwsSourceProvider) IsKnown ¶
func (r SippyUpdateParamsBodyR2EnableSippyAwsSourceProvider) IsKnown() bool
type SippyUpdateParamsBodyR2EnableSippyGcs ¶
type SippyUpdateParamsBodyR2EnableSippyGcs struct { // R2 bucket to copy objects to Destination param.Field[SippyUpdateParamsBodyR2EnableSippyGcsDestination] `json:"destination"` // GCS bucket to copy objects from Source param.Field[SippyUpdateParamsBodyR2EnableSippyGcsSource] `json:"source"` }
func (SippyUpdateParamsBodyR2EnableSippyGcs) MarshalJSON ¶
func (r SippyUpdateParamsBodyR2EnableSippyGcs) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBodyR2EnableSippyGcsDestination ¶
type SippyUpdateParamsBodyR2EnableSippyGcsDestination struct { // ID of a Cloudflare API token. This is the value labelled "Access Key ID" when // creating an API token from the // [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens). // // Sippy will use this token when writing objects to R2, so it is best to scope // this token to the bucket you're enabling Sippy for. AccessKeyID param.Field[string] `json:"accessKeyId"` Provider param.Field[Provider] `json:"provider"` // Value of a Cloudflare API token. This is the value labelled "Secret Access Key" // when creating an API token from the // [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens). // // Sippy will use this token when writing objects to R2, so it is best to scope // this token to the bucket you're enabling Sippy for. SecretAccessKey param.Field[string] `json:"secretAccessKey"` }
R2 bucket to copy objects to
func (SippyUpdateParamsBodyR2EnableSippyGcsDestination) MarshalJSON ¶
func (r SippyUpdateParamsBodyR2EnableSippyGcsDestination) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBodyR2EnableSippyGcsSource ¶
type SippyUpdateParamsBodyR2EnableSippyGcsSource struct { // Name of the GCS bucket Bucket param.Field[string] `json:"bucket"` // Client email of an IAM credential (ideally scoped to a single GCS bucket) ClientEmail param.Field[string] `json:"clientEmail"` // Private Key of an IAM credential (ideally scoped to a single GCS bucket) PrivateKey param.Field[string] `json:"privateKey"` Provider param.Field[SippyUpdateParamsBodyR2EnableSippyGcsSourceProvider] `json:"provider"` }
GCS bucket to copy objects from
func (SippyUpdateParamsBodyR2EnableSippyGcsSource) MarshalJSON ¶
func (r SippyUpdateParamsBodyR2EnableSippyGcsSource) MarshalJSON() (data []byte, err error)
type SippyUpdateParamsBodyR2EnableSippyGcsSourceProvider ¶
type SippyUpdateParamsBodyR2EnableSippyGcsSourceProvider string
const (
SippyUpdateParamsBodyR2EnableSippyGcsSourceProviderGcs SippyUpdateParamsBodyR2EnableSippyGcsSourceProvider = "gcs"
)
func (SippyUpdateParamsBodyR2EnableSippyGcsSourceProvider) IsKnown ¶
func (r SippyUpdateParamsBodyR2EnableSippyGcsSourceProvider) IsKnown() bool
type SippyUpdateParamsBodyUnion ¶
type SippyUpdateParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by r2.SippyUpdateParamsBodyR2EnableSippyAws, r2.SippyUpdateParamsBodyR2EnableSippyGcs, SippyUpdateParamsBody.
type SippyUpdateResponseEnvelope ¶
type SippyUpdateResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []string `json:"messages,required"` Result Sippy `json:"result,required"` // Whether the API call was successful Success SippyUpdateResponseEnvelopeSuccess `json:"success,required"` JSON sippyUpdateResponseEnvelopeJSON `json:"-"` }
func (*SippyUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SippyUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SippyUpdateResponseEnvelopeSuccess ¶
type SippyUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SippyUpdateResponseEnvelopeSuccessTrue SippyUpdateResponseEnvelopeSuccess = true
)
func (SippyUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SippyUpdateResponseEnvelopeSuccess) IsKnown() bool
type SortDirection ¶ added in v2.2.0
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.