r2

package
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type 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"`
	// Storage class for newly uploaded objects, unless specified otherwise.
	StorageClass BucketStorageClass `json:"storage_class"`
	JSON         bucketJSON         `json:"-"`
}

A single R2 bucket

func (*Bucket) UnmarshalJSON 

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

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 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 {
	// 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 {
	// Name of the bucket
	Name param.Field[string] `json:"name,required"`
	// Location of the bucket
	LocationHint param.Field[BucketNewParamsLocationHint] `json:"locationHint"`
	// Storage class for newly uploaded objects, unless specified otherwise.
	StorageClass param.Field[BucketNewParamsStorageClass] `json:"storageClass"`
}

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 BucketNewParamsStorageClass 

type BucketNewParamsStorageClass string

Storage class for newly uploaded objects, unless specified otherwise. 

const (
	BucketNewParamsStorageClassStandard         BucketNewParamsStorageClass = "Standard"
	BucketNewParamsStorageClassInfrequentAccess BucketNewParamsStorageClass = "InfrequentAccess"
)

func (BucketNewParamsStorageClass) IsKnown 

func (r BucketNewParamsStorageClass) 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 testcloudflare 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, accountID string, bucketName string, opts ...option.RequestOption) (res *BucketDeleteResponse, err error)

Deletes an existing R2 bucket.

func (*BucketService) Get 

func (r *BucketService) Get(ctx context.Context, accountID string, bucketName string, opts ...option.RequestOption) (res *Bucket, err error)

Gets metadata for an existing R2 bucket.

func (*BucketService) List 

func (r *BucketService) List(ctx context.Context, accountID string, query 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, accountID string, query BucketListParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[Bucket]

Lists all R2 buckets on your account

func (*BucketService) New 

func (r *BucketService) New(ctx context.Context, accountID string, body BucketNewParams, opts ...option.RequestOption) (res *Bucket, err error)

Creates a new R2 bucket.

type BucketStorageClass 

type BucketStorageClass string

Storage class for newly uploaded objects, unless specified otherwise. 

const (
	BucketStorageClassStandard         BucketStorageClass = "Standard"
	BucketStorageClassInfrequentAccess BucketStorageClass = "InfrequentAccess"
)

func (BucketStorageClass) IsKnown 

func (r BucketStorageClass) IsKnown() bool

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type MemberParam 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type Provider 

type Provider string
const (
	ProviderR2 Provider = "r2"
)

func (Provider) IsKnown 

func (r Provider) IsKnown() bool

type R2Service 

type R2Service struct {
	Options              []option.RequestOption
	Buckets              *BucketService
	Sippy                *SippyService
	TemporaryCredentials *TemporaryCredentialService
}

R2Service contains methods and other services that help with interacting with the testcloudflare 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 ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type 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 

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

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 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 testcloudflare 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, accountID string, bucketName string, opts ...option.RequestOption) (res *SippyDeleteResponse, err error)

Disables Sippy on this bucket

func (*SippyService) Get 

func (r *SippyService) Get(ctx context.Context, accountID string, bucketName string, 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, accountID string, bucketName string, body 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 {
	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 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type TemporaryCredentialNewParams 

type TemporaryCredentialNewParams struct {
	TemporaryCredential TemporaryCredentialParam `json:"temporary_credential,required"`
}

func (TemporaryCredentialNewParams) MarshalJSON 

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

type TemporaryCredentialNewResponse 

type TemporaryCredentialNewResponse struct {
	// ID for new access key
	AccessKeyID string `json:"accessKeyId"`
	// Secret access key
	SecretAccessKey string `json:"secretAccessKey"`
	// Security token
	SessionToken string                             `json:"sessionToken"`
	JSON         temporaryCredentialNewResponseJSON `json:"-"`
}

func (*TemporaryCredentialNewResponse) UnmarshalJSON 

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

type TemporaryCredentialNewResponseEnvelope 

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

func (*TemporaryCredentialNewResponseEnvelope) UnmarshalJSON 

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

type TemporaryCredentialNewResponseEnvelopeSuccess 

type TemporaryCredentialNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TemporaryCredentialNewResponseEnvelopeSuccessTrue TemporaryCredentialNewResponseEnvelopeSuccess = true
)

func (TemporaryCredentialNewResponseEnvelopeSuccess) IsKnown 

func (r TemporaryCredentialNewResponseEnvelopeSuccess) IsKnown() bool

type TemporaryCredentialParam 

type TemporaryCredentialParam struct {
	// Name of the R2 bucket
	Bucket param.Field[string] `json:"bucket,required"`
	// The parent access key id to use for signing
	ParentAccessKeyID param.Field[string] `json:"parentAccessKeyId,required"`
	// Permissions allowed on the credentials
	Permission param.Field[TemporaryCredentialPermission] `json:"permission,required"`
	// How long the credentials will live for in seconds
	TTLSeconds param.Field[float64] `json:"ttlSeconds,required"`
	// Optional object paths to scope the credentials to
	Objects param.Field[[]string] `json:"objects"`
	// Optional prefix paths to scope the credentials to
	Prefixes param.Field[[]string] `json:"prefixes"`
}

func (TemporaryCredentialParam) MarshalJSON 

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

type TemporaryCredentialPermission 

type TemporaryCredentialPermission string

Permissions allowed on the credentials 

const (
	TemporaryCredentialPermissionAdminReadWrite  TemporaryCredentialPermission = "admin-read-write"
	TemporaryCredentialPermissionAdminReadOnly   TemporaryCredentialPermission = "admin-read-only"
	TemporaryCredentialPermissionObjectReadWrite TemporaryCredentialPermission = "object-read-write"
	TemporaryCredentialPermissionObjectReadOnly  TemporaryCredentialPermission = "object-read-only"
)

func (TemporaryCredentialPermission) IsKnown 

func (r TemporaryCredentialPermission) IsKnown() bool

type TemporaryCredentialService 

type TemporaryCredentialService struct {
	Options []option.RequestOption
}

TemporaryCredentialService contains methods and other services that help with interacting with the testcloudflare 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 NewTemporaryCredentialService method instead.

func NewTemporaryCredentialService 

func NewTemporaryCredentialService(opts ...option.RequestOption) (r *TemporaryCredentialService)

NewTemporaryCredentialService 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 (*TemporaryCredentialService) New 

func (r *TemporaryCredentialService) New(ctx context.Context, accountID string, body TemporaryCredentialNewParams, opts ...option.RequestOption) (res *TemporaryCredentialNewResponse, err error)

Creates temporary access credentials on a bucket that can be optionally scoped to prefixes or objects.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.