r2_data_catalog

package
v6.7.0 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

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 CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

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 MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

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 RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type 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 CredentialNewParams

type CredentialNewParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Provides the Cloudflare API token for accessing R2.
	Token param.Field[string] `json:"token,required"`
}

func (CredentialNewParams) MarshalJSON

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

type CredentialNewResponse

type CredentialNewResponse = interface{}

type CredentialNewResponseEnvelope

type CredentialNewResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []CredentialNewResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []CredentialNewResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool                              `json:"success,required"`
	Result  CredentialNewResponse             `json:"result,nullable"`
	JSON    credentialNewResponseEnvelopeJSON `json:"-"`
}

func (*CredentialNewResponseEnvelope) UnmarshalJSON

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

type CredentialNewResponseEnvelopeErrors

type CredentialNewResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                  `json:"message,required"`
	JSON    credentialNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CredentialNewResponseEnvelopeErrors) UnmarshalJSON

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

type CredentialNewResponseEnvelopeMessages

type CredentialNewResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                    `json:"message,required"`
	JSON    credentialNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CredentialNewResponseEnvelopeMessages) UnmarshalJSON

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

type CredentialService

type CredentialService struct {
	Options []option.RequestOption
}

CredentialService 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 NewCredentialService method instead.

func NewCredentialService

func NewCredentialService(opts ...option.RequestOption) (r *CredentialService)

NewCredentialService 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 (*CredentialService) New

func (r *CredentialService) New(ctx context.Context, bucketName string, params CredentialNewParams, opts ...option.RequestOption) (res *CredentialNewResponse, err error)

Store authentication credentials for a catalog. These credentials are used to authenticate with R2 storage when performing catalog operations.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type MaintenanceConfigGetParams

type MaintenanceConfigGetParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type MaintenanceConfigGetResponse

type MaintenanceConfigGetResponse struct {
	// Shows the credential configuration status.
	CredentialStatus MaintenanceConfigGetResponseCredentialStatus `json:"credential_status,required"`
	// Configures maintenance for the catalog.
	MaintenanceConfig MaintenanceConfigGetResponseMaintenanceConfig `json:"maintenance_config,required"`
	JSON              maintenanceConfigGetResponseJSON              `json:"-"`
}

Contains maintenance configuration and credential status.

func (*MaintenanceConfigGetResponse) UnmarshalJSON

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

type MaintenanceConfigGetResponseCredentialStatus

type MaintenanceConfigGetResponseCredentialStatus string

Shows the credential configuration status.

const (
	MaintenanceConfigGetResponseCredentialStatusPresent MaintenanceConfigGetResponseCredentialStatus = "present"
	MaintenanceConfigGetResponseCredentialStatusAbsent  MaintenanceConfigGetResponseCredentialStatus = "absent"
)

func (MaintenanceConfigGetResponseCredentialStatus) IsKnown

type MaintenanceConfigGetResponseEnvelope

type MaintenanceConfigGetResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []MaintenanceConfigGetResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []MaintenanceConfigGetResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Contains maintenance configuration and credential status.
	Result MaintenanceConfigGetResponse             `json:"result"`
	JSON   maintenanceConfigGetResponseEnvelopeJSON `json:"-"`
}

func (*MaintenanceConfigGetResponseEnvelope) UnmarshalJSON

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

type MaintenanceConfigGetResponseEnvelopeErrors

type MaintenanceConfigGetResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                         `json:"message,required"`
	JSON    maintenanceConfigGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*MaintenanceConfigGetResponseEnvelopeErrors) UnmarshalJSON

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

type MaintenanceConfigGetResponseEnvelopeMessages

type MaintenanceConfigGetResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                           `json:"message,required"`
	JSON    maintenanceConfigGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*MaintenanceConfigGetResponseEnvelopeMessages) UnmarshalJSON

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

type MaintenanceConfigGetResponseMaintenanceConfig

type MaintenanceConfigGetResponseMaintenanceConfig struct {
	// Configures compaction for catalog maintenance.
	Compaction MaintenanceConfigGetResponseMaintenanceConfigCompaction `json:"compaction"`
	// Configures snapshot expiration settings.
	SnapshotExpiration MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration `json:"snapshot_expiration"`
	JSON               maintenanceConfigGetResponseMaintenanceConfigJSON               `json:"-"`
}

Configures maintenance for the catalog.

func (*MaintenanceConfigGetResponseMaintenanceConfig) UnmarshalJSON

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

type MaintenanceConfigGetResponseMaintenanceConfigCompaction

type MaintenanceConfigGetResponseMaintenanceConfigCompaction struct {
	// Specifies the state of maintenance operations.
	State MaintenanceConfigGetResponseMaintenanceConfigCompactionState `json:"state,required"`
	// Sets the target file size for compaction in megabytes.
	TargetSizeMB MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB `json:"target_size_mb,required"`
	JSON         maintenanceConfigGetResponseMaintenanceConfigCompactionJSON         `json:"-"`
}

Configures compaction for catalog maintenance.

func (*MaintenanceConfigGetResponseMaintenanceConfigCompaction) UnmarshalJSON

type MaintenanceConfigGetResponseMaintenanceConfigCompactionState

type MaintenanceConfigGetResponseMaintenanceConfigCompactionState string

Specifies the state of maintenance operations.

const (
	MaintenanceConfigGetResponseMaintenanceConfigCompactionStateEnabled  MaintenanceConfigGetResponseMaintenanceConfigCompactionState = "enabled"
	MaintenanceConfigGetResponseMaintenanceConfigCompactionStateDisabled MaintenanceConfigGetResponseMaintenanceConfigCompactionState = "disabled"
)

func (MaintenanceConfigGetResponseMaintenanceConfigCompactionState) IsKnown

type MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB

type MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB string

Sets the target file size for compaction in megabytes.

const (
	MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB64  MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "64"
	MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB128 MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "128"
	MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB256 MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "256"
	MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB512 MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "512"
)

func (MaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB) IsKnown

type MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration added in v6.6.0

type MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration struct {
	// Specifies the maximum age for snapshots. The system deletes snapshots older than
	// this age. Format: <number><unit> where unit is d (days), h (hours), m (minutes),
	// or s (seconds). Examples: "7d" (7 days), "48h" (48 hours), "2880m" (2,880
	// minutes).
	MaxSnapshotAge string `json:"max_snapshot_age,required"`
	// Specifies the minimum number of snapshots to retain.
	MinSnapshotsToKeep int64 `json:"min_snapshots_to_keep,required"`
	// Specifies the state of maintenance operations.
	State MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState `json:"state,required"`
	JSON  maintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationJSON  `json:"-"`
}

Configures snapshot expiration settings.

func (*MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration) UnmarshalJSON added in v6.6.0

type MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState added in v6.6.0

type MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState string

Specifies the state of maintenance operations.

const (
	MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationStateEnabled  MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState = "enabled"
	MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationStateDisabled MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState = "disabled"
)

func (MaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState) IsKnown added in v6.6.0

type MaintenanceConfigService

type MaintenanceConfigService struct {
	Options []option.RequestOption
}

MaintenanceConfigService 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 NewMaintenanceConfigService method instead.

func NewMaintenanceConfigService

func NewMaintenanceConfigService(opts ...option.RequestOption) (r *MaintenanceConfigService)

NewMaintenanceConfigService 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 (*MaintenanceConfigService) Get

Retrieve the maintenance configuration for a specific catalog, including compaction settings and credential status.

func (*MaintenanceConfigService) Update

Update the maintenance configuration for a catalog. This allows you to enable or disable compaction and adjust target file sizes for optimization.

type MaintenanceConfigUpdateParams

type MaintenanceConfigUpdateParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Updates compaction configuration (all fields optional).
	Compaction param.Field[MaintenanceConfigUpdateParamsCompaction] `json:"compaction"`
	// Updates snapshot expiration configuration (all fields optional).
	SnapshotExpiration param.Field[MaintenanceConfigUpdateParamsSnapshotExpiration] `json:"snapshot_expiration"`
}

func (MaintenanceConfigUpdateParams) MarshalJSON

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

type MaintenanceConfigUpdateParamsCompaction

type MaintenanceConfigUpdateParamsCompaction struct {
	// Updates the state optionally.
	State param.Field[MaintenanceConfigUpdateParamsCompactionState] `json:"state"`
	// Updates the target file size optionally.
	TargetSizeMB param.Field[MaintenanceConfigUpdateParamsCompactionTargetSizeMB] `json:"target_size_mb"`
}

Updates compaction configuration (all fields optional).

func (MaintenanceConfigUpdateParamsCompaction) MarshalJSON

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

type MaintenanceConfigUpdateParamsCompactionState

type MaintenanceConfigUpdateParamsCompactionState string

Updates the state optionally.

const (
	MaintenanceConfigUpdateParamsCompactionStateEnabled  MaintenanceConfigUpdateParamsCompactionState = "enabled"
	MaintenanceConfigUpdateParamsCompactionStateDisabled MaintenanceConfigUpdateParamsCompactionState = "disabled"
)

func (MaintenanceConfigUpdateParamsCompactionState) IsKnown

type MaintenanceConfigUpdateParamsCompactionTargetSizeMB

type MaintenanceConfigUpdateParamsCompactionTargetSizeMB string

Updates the target file size optionally.

const (
	MaintenanceConfigUpdateParamsCompactionTargetSizeMB64  MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "64"
	MaintenanceConfigUpdateParamsCompactionTargetSizeMB128 MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "128"
	MaintenanceConfigUpdateParamsCompactionTargetSizeMB256 MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "256"
	MaintenanceConfigUpdateParamsCompactionTargetSizeMB512 MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "512"
)

func (MaintenanceConfigUpdateParamsCompactionTargetSizeMB) IsKnown

type MaintenanceConfigUpdateParamsSnapshotExpiration added in v6.6.0

type MaintenanceConfigUpdateParamsSnapshotExpiration struct {
	// Updates the maximum age for snapshots optionally.
	MaxSnapshotAge param.Field[string] `json:"max_snapshot_age"`
	// Updates the minimum number of snapshots to retain optionally.
	MinSnapshotsToKeep param.Field[int64] `json:"min_snapshots_to_keep"`
	// Updates the state optionally.
	State param.Field[MaintenanceConfigUpdateParamsSnapshotExpirationState] `json:"state"`
}

Updates snapshot expiration configuration (all fields optional).

func (MaintenanceConfigUpdateParamsSnapshotExpiration) MarshalJSON added in v6.6.0

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

type MaintenanceConfigUpdateParamsSnapshotExpirationState added in v6.6.0

type MaintenanceConfigUpdateParamsSnapshotExpirationState string

Updates the state optionally.

const (
	MaintenanceConfigUpdateParamsSnapshotExpirationStateEnabled  MaintenanceConfigUpdateParamsSnapshotExpirationState = "enabled"
	MaintenanceConfigUpdateParamsSnapshotExpirationStateDisabled MaintenanceConfigUpdateParamsSnapshotExpirationState = "disabled"
)

func (MaintenanceConfigUpdateParamsSnapshotExpirationState) IsKnown added in v6.6.0

type MaintenanceConfigUpdateResponse

type MaintenanceConfigUpdateResponse struct {
	// Configures compaction for catalog maintenance.
	Compaction MaintenanceConfigUpdateResponseCompaction `json:"compaction"`
	// Configures snapshot expiration settings.
	SnapshotExpiration MaintenanceConfigUpdateResponseSnapshotExpiration `json:"snapshot_expiration"`
	JSON               maintenanceConfigUpdateResponseJSON               `json:"-"`
}

Configures maintenance for the catalog.

func (*MaintenanceConfigUpdateResponse) UnmarshalJSON

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

type MaintenanceConfigUpdateResponseCompaction

type MaintenanceConfigUpdateResponseCompaction struct {
	// Specifies the state of maintenance operations.
	State MaintenanceConfigUpdateResponseCompactionState `json:"state,required"`
	// Sets the target file size for compaction in megabytes.
	TargetSizeMB MaintenanceConfigUpdateResponseCompactionTargetSizeMB `json:"target_size_mb,required"`
	JSON         maintenanceConfigUpdateResponseCompactionJSON         `json:"-"`
}

Configures compaction for catalog maintenance.

func (*MaintenanceConfigUpdateResponseCompaction) UnmarshalJSON

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

type MaintenanceConfigUpdateResponseCompactionState

type MaintenanceConfigUpdateResponseCompactionState string

Specifies the state of maintenance operations.

const (
	MaintenanceConfigUpdateResponseCompactionStateEnabled  MaintenanceConfigUpdateResponseCompactionState = "enabled"
	MaintenanceConfigUpdateResponseCompactionStateDisabled MaintenanceConfigUpdateResponseCompactionState = "disabled"
)

func (MaintenanceConfigUpdateResponseCompactionState) IsKnown

type MaintenanceConfigUpdateResponseCompactionTargetSizeMB

type MaintenanceConfigUpdateResponseCompactionTargetSizeMB string

Sets the target file size for compaction in megabytes.

const (
	MaintenanceConfigUpdateResponseCompactionTargetSizeMB64  MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "64"
	MaintenanceConfigUpdateResponseCompactionTargetSizeMB128 MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "128"
	MaintenanceConfigUpdateResponseCompactionTargetSizeMB256 MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "256"
	MaintenanceConfigUpdateResponseCompactionTargetSizeMB512 MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "512"
)

func (MaintenanceConfigUpdateResponseCompactionTargetSizeMB) IsKnown

type MaintenanceConfigUpdateResponseEnvelope

type MaintenanceConfigUpdateResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []MaintenanceConfigUpdateResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []MaintenanceConfigUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Configures maintenance for the catalog.
	Result MaintenanceConfigUpdateResponse             `json:"result"`
	JSON   maintenanceConfigUpdateResponseEnvelopeJSON `json:"-"`
}

func (*MaintenanceConfigUpdateResponseEnvelope) UnmarshalJSON

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

type MaintenanceConfigUpdateResponseEnvelopeErrors

type MaintenanceConfigUpdateResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                            `json:"message,required"`
	JSON    maintenanceConfigUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*MaintenanceConfigUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type MaintenanceConfigUpdateResponseEnvelopeMessages

type MaintenanceConfigUpdateResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                              `json:"message,required"`
	JSON    maintenanceConfigUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*MaintenanceConfigUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type MaintenanceConfigUpdateResponseSnapshotExpiration added in v6.6.0

type MaintenanceConfigUpdateResponseSnapshotExpiration struct {
	// Specifies the maximum age for snapshots. The system deletes snapshots older than
	// this age. Format: <number><unit> where unit is d (days), h (hours), m (minutes),
	// or s (seconds). Examples: "7d" (7 days), "48h" (48 hours), "2880m" (2,880
	// minutes).
	MaxSnapshotAge string `json:"max_snapshot_age,required"`
	// Specifies the minimum number of snapshots to retain.
	MinSnapshotsToKeep int64 `json:"min_snapshots_to_keep,required"`
	// Specifies the state of maintenance operations.
	State MaintenanceConfigUpdateResponseSnapshotExpirationState `json:"state,required"`
	JSON  maintenanceConfigUpdateResponseSnapshotExpirationJSON  `json:"-"`
}

Configures snapshot expiration settings.

func (*MaintenanceConfigUpdateResponseSnapshotExpiration) UnmarshalJSON added in v6.6.0

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

type MaintenanceConfigUpdateResponseSnapshotExpirationState added in v6.6.0

type MaintenanceConfigUpdateResponseSnapshotExpirationState string

Specifies the state of maintenance operations.

const (
	MaintenanceConfigUpdateResponseSnapshotExpirationStateEnabled  MaintenanceConfigUpdateResponseSnapshotExpirationState = "enabled"
	MaintenanceConfigUpdateResponseSnapshotExpirationStateDisabled MaintenanceConfigUpdateResponseSnapshotExpirationState = "disabled"
)

func (MaintenanceConfigUpdateResponseSnapshotExpirationState) IsKnown added in v6.6.0

type Member

type Member = shared.Member

This is an alias to an internal type.

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 MemberPolicy

type MemberPolicy = shared.MemberPolicy

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 NamespaceListParams

type NamespaceListParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Maximum number of namespaces to return per page. Defaults to 100, maximum 1000.
	PageSize param.Field[int64] `query:"page_size"`
	// Opaque pagination token from a previous response. Use this to fetch the next
	// page of results.
	PageToken param.Field[string] `query:"page_token"`
	// Parent namespace to filter by. Only returns direct children of this namespace.
	// For nested namespaces, use %1F as separator (e.g., "bronze%1Fanalytics"). Omit
	// this parameter to list top-level namespaces.
	Parent param.Field[string] `query:"parent"`
	// Whether to include additional metadata (timestamps). When true, response
	// includes created_at and updated_at arrays.
	ReturnDetails param.Field[bool] `query:"return_details"`
	// Whether to include namespace UUIDs in the response. Set to true to receive the
	// namespace_uuids array.
	ReturnUUIDs param.Field[bool] `query:"return_uuids"`
}

func (NamespaceListParams) URLQuery

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

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

type NamespaceListResponse

type NamespaceListResponse struct {
	// Lists namespaces in the catalog.
	Namespaces [][]string `json:"namespaces,required"`
	// Contains detailed metadata for each namespace when return_details is true. Each
	// object includes the namespace, UUID, and timestamps.
	Details []NamespaceListResponseDetail `json:"details,nullable"`
	// Contains UUIDs for each namespace when return_uuids is true. The order
	// corresponds to the namespaces array.
	NamespaceUUIDs []string `json:"namespace_uuids,nullable" format:"uuid"`
	// Use this opaque token to fetch the next page of results. A null or absent value
	// indicates the last page.
	NextPageToken string                    `json:"next_page_token,nullable"`
	JSON          namespaceListResponseJSON `json:"-"`
}

Contains the list of namespaces with optional pagination.

func (*NamespaceListResponse) UnmarshalJSON

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

type NamespaceListResponseDetail

type NamespaceListResponseDetail struct {
	// Specifies the hierarchical namespace parts as an array of strings. For example,
	// ["bronze", "analytics"] represents the namespace "bronze.analytics".
	Namespace []string `json:"namespace,required"`
	// Contains the UUID that persists across renames.
	NamespaceUUID string `json:"namespace_uuid,required" format:"uuid"`
	// Indicates the creation timestamp in ISO 8601 format.
	CreatedAt time.Time `json:"created_at,nullable" format:"date-time"`
	// Shows the last update timestamp in ISO 8601 format. Null if never updated.
	UpdatedAt time.Time                       `json:"updated_at,nullable" format:"date-time"`
	JSON      namespaceListResponseDetailJSON `json:"-"`
}

Contains namespace with metadata details.

func (*NamespaceListResponseDetail) UnmarshalJSON

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

type NamespaceListResponseEnvelope

type NamespaceListResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []NamespaceListResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []NamespaceListResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Contains the list of namespaces with optional pagination.
	Result NamespaceListResponse             `json:"result"`
	JSON   namespaceListResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceListResponseEnvelope) UnmarshalJSON

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

type NamespaceListResponseEnvelopeErrors

type NamespaceListResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                  `json:"message,required"`
	JSON    namespaceListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NamespaceListResponseEnvelopeErrors) UnmarshalJSON

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

type NamespaceListResponseEnvelopeMessages

type NamespaceListResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                    `json:"message,required"`
	JSON    namespaceListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NamespaceListResponseEnvelopeMessages) UnmarshalJSON

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

type NamespaceService

type NamespaceService struct {
	Options []option.RequestOption
	Tables  *NamespaceTableService
}

NamespaceService 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 NewNamespaceService method instead.

func NewNamespaceService

func NewNamespaceService(opts ...option.RequestOption) (r *NamespaceService)

NewNamespaceService 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 (*NamespaceService) List

func (r *NamespaceService) List(ctx context.Context, bucketName string, params NamespaceListParams, opts ...option.RequestOption) (res *NamespaceListResponse, err error)

Returns a list of namespaces in the specified R2 catalog. Supports hierarchical filtering and pagination for efficient traversal of large namespace hierarchies.

type NamespaceTableListParams

type NamespaceTableListParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Maximum number of tables to return per page. Defaults to 100, maximum 1000.
	PageSize param.Field[int64] `query:"page_size"`
	// Opaque pagination token from a previous response. Use this to fetch the next
	// page of results.
	PageToken param.Field[string] `query:"page_token"`
	// Whether to include additional metadata (timestamps, locations). When true,
	// response includes created_at, updated_at, metadata_locations, and locations
	// arrays.
	ReturnDetails param.Field[bool] `query:"return_details"`
	// Whether to include table UUIDs in the response. Set to true to receive the
	// table_uuids array.
	ReturnUUIDs param.Field[bool] `query:"return_uuids"`
}

func (NamespaceTableListParams) URLQuery

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

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

type NamespaceTableListResponse

type NamespaceTableListResponse struct {
	// Lists tables in the namespace.
	Identifiers []NamespaceTableListResponseIdentifier `json:"identifiers,required"`
	// Contains detailed metadata for each table when return_details is true. Each
	// object includes identifier, UUID, timestamps, and locations.
	Details []NamespaceTableListResponseDetail `json:"details,nullable"`
	// Use this opaque token to fetch the next page of results. A null or absent value
	// indicates the last page.
	NextPageToken string `json:"next_page_token,nullable"`
	// Contains UUIDs for each table when return_uuids is true. The order corresponds
	// to the identifiers array.
	TableUUIDs []string                       `json:"table_uuids,nullable" format:"uuid"`
	JSON       namespaceTableListResponseJSON `json:"-"`
}

Contains the list of tables with optional pagination.

func (*NamespaceTableListResponse) UnmarshalJSON

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

type NamespaceTableListResponseDetail

type NamespaceTableListResponseDetail struct {
	// Specifies a unique table identifier within a catalog.
	Identifier NamespaceTableListResponseDetailsIdentifier `json:"identifier,required"`
	// Contains the UUID that persists across renames.
	TableUUID string `json:"table_uuid,required" format:"uuid"`
	// Indicates the creation timestamp in ISO 8601 format.
	CreatedAt time.Time `json:"created_at,nullable" format:"date-time"`
	// Specifies the base S3 URI for table storage location.
	Location string `json:"location,nullable"`
	// Contains the S3 URI to table metadata file. Null for staged tables.
	MetadataLocation string `json:"metadata_location,nullable"`
	// Shows the last update timestamp in ISO 8601 format. Null if never updated.
	UpdatedAt time.Time                            `json:"updated_at,nullable" format:"date-time"`
	JSON      namespaceTableListResponseDetailJSON `json:"-"`
}

Contains table with metadata.

func (*NamespaceTableListResponseDetail) UnmarshalJSON

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

type NamespaceTableListResponseDetailsIdentifier

type NamespaceTableListResponseDetailsIdentifier struct {
	// Specifies the table name.
	Name string `json:"name,required"`
	// Specifies the hierarchical namespace parts as an array of strings. For example,
	// ["bronze", "analytics"] represents the namespace "bronze.analytics".
	Namespace []string                                        `json:"namespace,required"`
	JSON      namespaceTableListResponseDetailsIdentifierJSON `json:"-"`
}

Specifies a unique table identifier within a catalog.

func (*NamespaceTableListResponseDetailsIdentifier) UnmarshalJSON

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

type NamespaceTableListResponseEnvelope

type NamespaceTableListResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []NamespaceTableListResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []NamespaceTableListResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Contains the list of tables with optional pagination.
	Result NamespaceTableListResponse             `json:"result"`
	JSON   namespaceTableListResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceTableListResponseEnvelope) UnmarshalJSON

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

type NamespaceTableListResponseEnvelopeErrors

type NamespaceTableListResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                       `json:"message,required"`
	JSON    namespaceTableListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NamespaceTableListResponseEnvelopeErrors) UnmarshalJSON

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

type NamespaceTableListResponseEnvelopeMessages

type NamespaceTableListResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                         `json:"message,required"`
	JSON    namespaceTableListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NamespaceTableListResponseEnvelopeMessages) UnmarshalJSON

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

type NamespaceTableListResponseIdentifier

type NamespaceTableListResponseIdentifier struct {
	// Specifies the table name.
	Name string `json:"name,required"`
	// Specifies the hierarchical namespace parts as an array of strings. For example,
	// ["bronze", "analytics"] represents the namespace "bronze.analytics".
	Namespace []string                                 `json:"namespace,required"`
	JSON      namespaceTableListResponseIdentifierJSON `json:"-"`
}

Specifies a unique table identifier within a catalog.

func (*NamespaceTableListResponseIdentifier) UnmarshalJSON

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

type NamespaceTableMaintenanceConfigGetParams

type NamespaceTableMaintenanceConfigGetParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type NamespaceTableMaintenanceConfigGetResponse

type NamespaceTableMaintenanceConfigGetResponse struct {
	// Configures maintenance for the table.
	MaintenanceConfig NamespaceTableMaintenanceConfigGetResponseMaintenanceConfig `json:"maintenance_config,required"`
	JSON              namespaceTableMaintenanceConfigGetResponseJSON              `json:"-"`
}

Contains table maintenance configuration.

func (*NamespaceTableMaintenanceConfigGetResponse) UnmarshalJSON

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

type NamespaceTableMaintenanceConfigGetResponseEnvelope

type NamespaceTableMaintenanceConfigGetResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []NamespaceTableMaintenanceConfigGetResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []NamespaceTableMaintenanceConfigGetResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Contains table maintenance configuration.
	Result NamespaceTableMaintenanceConfigGetResponse             `json:"result"`
	JSON   namespaceTableMaintenanceConfigGetResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceTableMaintenanceConfigGetResponseEnvelope) UnmarshalJSON

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

type NamespaceTableMaintenanceConfigGetResponseEnvelopeErrors

type NamespaceTableMaintenanceConfigGetResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                                       `json:"message,required"`
	JSON    namespaceTableMaintenanceConfigGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NamespaceTableMaintenanceConfigGetResponseEnvelopeErrors) UnmarshalJSON

type NamespaceTableMaintenanceConfigGetResponseEnvelopeMessages

type NamespaceTableMaintenanceConfigGetResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                                         `json:"message,required"`
	JSON    namespaceTableMaintenanceConfigGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NamespaceTableMaintenanceConfigGetResponseEnvelopeMessages) UnmarshalJSON

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfig

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfig struct {
	// Configures compaction settings for table optimization.
	Compaction NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompaction `json:"compaction"`
	// Configures snapshot expiration settings.
	SnapshotExpiration NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration `json:"snapshot_expiration"`
	JSON               namespaceTableMaintenanceConfigGetResponseMaintenanceConfigJSON               `json:"-"`
}

Configures maintenance for the table.

func (*NamespaceTableMaintenanceConfigGetResponseMaintenanceConfig) UnmarshalJSON

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompaction

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompaction struct {
	// Specifies the state of maintenance operations.
	State NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionState `json:"state,required"`
	// Sets the target file size for compaction in megabytes.
	TargetSizeMB NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB `json:"target_size_mb,required"`
	JSON         namespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionJSON         `json:"-"`
}

Configures compaction settings for table optimization.

func (*NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompaction) UnmarshalJSON

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionState

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionState string

Specifies the state of maintenance operations.

const (
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionStateEnabled  NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionState = "enabled"
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionStateDisabled NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionState = "disabled"
)

func (NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionState) IsKnown

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB string

Sets the target file size for compaction in megabytes.

const (
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB64  NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "64"
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB128 NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "128"
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB256 NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "256"
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB512 NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB = "512"
)

func (NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigCompactionTargetSizeMB) IsKnown

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration added in v6.6.0

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration struct {
	// Specifies the maximum age for snapshots. The system deletes snapshots older than
	// this age. Format: <number><unit> where unit is d (days), h (hours), m (minutes),
	// or s (seconds). Examples: "7d" (7 days), "48h" (48 hours), "2880m" (2,880
	// minutes).
	MaxSnapshotAge string `json:"max_snapshot_age,required"`
	// Specifies the minimum number of snapshots to retain.
	MinSnapshotsToKeep int64 `json:"min_snapshots_to_keep,required"`
	// Specifies the state of maintenance operations.
	State NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState `json:"state,required"`
	JSON  namespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationJSON  `json:"-"`
}

Configures snapshot expiration settings.

func (*NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpiration) UnmarshalJSON added in v6.6.0

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState added in v6.6.0

type NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState string

Specifies the state of maintenance operations.

const (
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationStateEnabled  NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState = "enabled"
	NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationStateDisabled NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState = "disabled"
)

func (NamespaceTableMaintenanceConfigGetResponseMaintenanceConfigSnapshotExpirationState) IsKnown added in v6.6.0

type NamespaceTableMaintenanceConfigService

type NamespaceTableMaintenanceConfigService struct {
	Options []option.RequestOption
}

NamespaceTableMaintenanceConfigService 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 NewNamespaceTableMaintenanceConfigService method instead.

func NewNamespaceTableMaintenanceConfigService

func NewNamespaceTableMaintenanceConfigService(opts ...option.RequestOption) (r *NamespaceTableMaintenanceConfigService)

NewNamespaceTableMaintenanceConfigService 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 (*NamespaceTableMaintenanceConfigService) Get

Retrieve the maintenance configuration for a specific table, including compaction settings.

func (*NamespaceTableMaintenanceConfigService) Update

Update the maintenance configuration for a specific table. This allows you to enable or disable compaction and adjust target file sizes for optimization.

type NamespaceTableMaintenanceConfigUpdateParams

type NamespaceTableMaintenanceConfigUpdateParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Updates compaction configuration (all fields optional).
	Compaction param.Field[NamespaceTableMaintenanceConfigUpdateParamsCompaction] `json:"compaction"`
	// Updates snapshot expiration configuration (all fields optional).
	SnapshotExpiration param.Field[NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpiration] `json:"snapshot_expiration"`
}

func (NamespaceTableMaintenanceConfigUpdateParams) MarshalJSON

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

type NamespaceTableMaintenanceConfigUpdateParamsCompaction

type NamespaceTableMaintenanceConfigUpdateParamsCompaction struct {
	// Updates the state optionally.
	State param.Field[NamespaceTableMaintenanceConfigUpdateParamsCompactionState] `json:"state"`
	// Updates the target file size optionally.
	TargetSizeMB param.Field[NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB] `json:"target_size_mb"`
}

Updates compaction configuration (all fields optional).

func (NamespaceTableMaintenanceConfigUpdateParamsCompaction) MarshalJSON

type NamespaceTableMaintenanceConfigUpdateParamsCompactionState

type NamespaceTableMaintenanceConfigUpdateParamsCompactionState string

Updates the state optionally.

const (
	NamespaceTableMaintenanceConfigUpdateParamsCompactionStateEnabled  NamespaceTableMaintenanceConfigUpdateParamsCompactionState = "enabled"
	NamespaceTableMaintenanceConfigUpdateParamsCompactionStateDisabled NamespaceTableMaintenanceConfigUpdateParamsCompactionState = "disabled"
)

func (NamespaceTableMaintenanceConfigUpdateParamsCompactionState) IsKnown

type NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB

type NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB string

Updates the target file size optionally.

const (
	NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB64  NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB = "64"
	NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB128 NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB = "128"
	NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB256 NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB = "256"
	NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB512 NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB = "512"
)

func (NamespaceTableMaintenanceConfigUpdateParamsCompactionTargetSizeMB) IsKnown

type NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpiration added in v6.6.0

type NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpiration struct {
	// Updates the maximum age for snapshots optionally.
	MaxSnapshotAge param.Field[string] `json:"max_snapshot_age"`
	// Updates the minimum number of snapshots to retain optionally.
	MinSnapshotsToKeep param.Field[int64] `json:"min_snapshots_to_keep"`
	// Updates the state optionally.
	State param.Field[NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationState] `json:"state"`
}

Updates snapshot expiration configuration (all fields optional).

func (NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpiration) MarshalJSON added in v6.6.0

type NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationState added in v6.6.0

type NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationState string

Updates the state optionally.

const (
	NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationStateEnabled  NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationState = "enabled"
	NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationStateDisabled NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationState = "disabled"
)

func (NamespaceTableMaintenanceConfigUpdateParamsSnapshotExpirationState) IsKnown added in v6.6.0

type NamespaceTableMaintenanceConfigUpdateResponse

type NamespaceTableMaintenanceConfigUpdateResponse struct {
	// Configures compaction settings for table optimization.
	Compaction NamespaceTableMaintenanceConfigUpdateResponseCompaction `json:"compaction"`
	// Configures snapshot expiration settings.
	SnapshotExpiration NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpiration `json:"snapshot_expiration"`
	JSON               namespaceTableMaintenanceConfigUpdateResponseJSON               `json:"-"`
}

Configures maintenance for the table.

func (*NamespaceTableMaintenanceConfigUpdateResponse) UnmarshalJSON

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

type NamespaceTableMaintenanceConfigUpdateResponseCompaction

type NamespaceTableMaintenanceConfigUpdateResponseCompaction struct {
	// Specifies the state of maintenance operations.
	State NamespaceTableMaintenanceConfigUpdateResponseCompactionState `json:"state,required"`
	// Sets the target file size for compaction in megabytes.
	TargetSizeMB NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB `json:"target_size_mb,required"`
	JSON         namespaceTableMaintenanceConfigUpdateResponseCompactionJSON         `json:"-"`
}

Configures compaction settings for table optimization.

func (*NamespaceTableMaintenanceConfigUpdateResponseCompaction) UnmarshalJSON

type NamespaceTableMaintenanceConfigUpdateResponseCompactionState

type NamespaceTableMaintenanceConfigUpdateResponseCompactionState string

Specifies the state of maintenance operations.

const (
	NamespaceTableMaintenanceConfigUpdateResponseCompactionStateEnabled  NamespaceTableMaintenanceConfigUpdateResponseCompactionState = "enabled"
	NamespaceTableMaintenanceConfigUpdateResponseCompactionStateDisabled NamespaceTableMaintenanceConfigUpdateResponseCompactionState = "disabled"
)

func (NamespaceTableMaintenanceConfigUpdateResponseCompactionState) IsKnown

type NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB

type NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB string

Sets the target file size for compaction in megabytes.

const (
	NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB64  NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB = "64"
	NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB128 NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB = "128"
	NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB256 NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB = "256"
	NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB512 NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB = "512"
)

func (NamespaceTableMaintenanceConfigUpdateResponseCompactionTargetSizeMB) IsKnown

type NamespaceTableMaintenanceConfigUpdateResponseEnvelope

type NamespaceTableMaintenanceConfigUpdateResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []NamespaceTableMaintenanceConfigUpdateResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []NamespaceTableMaintenanceConfigUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Configures maintenance for the table.
	Result NamespaceTableMaintenanceConfigUpdateResponse             `json:"result"`
	JSON   namespaceTableMaintenanceConfigUpdateResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceTableMaintenanceConfigUpdateResponseEnvelope) UnmarshalJSON

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

type NamespaceTableMaintenanceConfigUpdateResponseEnvelopeErrors

type NamespaceTableMaintenanceConfigUpdateResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                                          `json:"message,required"`
	JSON    namespaceTableMaintenanceConfigUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NamespaceTableMaintenanceConfigUpdateResponseEnvelopeErrors) UnmarshalJSON

type NamespaceTableMaintenanceConfigUpdateResponseEnvelopeMessages

type NamespaceTableMaintenanceConfigUpdateResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                                            `json:"message,required"`
	JSON    namespaceTableMaintenanceConfigUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NamespaceTableMaintenanceConfigUpdateResponseEnvelopeMessages) UnmarshalJSON

type NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpiration added in v6.6.0

type NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpiration struct {
	// Specifies the maximum age for snapshots. The system deletes snapshots older than
	// this age. Format: <number><unit> where unit is d (days), h (hours), m (minutes),
	// or s (seconds). Examples: "7d" (7 days), "48h" (48 hours), "2880m" (2,880
	// minutes).
	MaxSnapshotAge string `json:"max_snapshot_age,required"`
	// Specifies the minimum number of snapshots to retain.
	MinSnapshotsToKeep int64 `json:"min_snapshots_to_keep,required"`
	// Specifies the state of maintenance operations.
	State NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationState `json:"state,required"`
	JSON  namespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationJSON  `json:"-"`
}

Configures snapshot expiration settings.

func (*NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpiration) UnmarshalJSON added in v6.6.0

type NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationState added in v6.6.0

type NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationState string

Specifies the state of maintenance operations.

const (
	NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationStateEnabled  NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationState = "enabled"
	NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationStateDisabled NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationState = "disabled"
)

func (NamespaceTableMaintenanceConfigUpdateResponseSnapshotExpirationState) IsKnown added in v6.6.0

type NamespaceTableService

type NamespaceTableService struct {
	Options            []option.RequestOption
	MaintenanceConfigs *NamespaceTableMaintenanceConfigService
}

NamespaceTableService 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 NewNamespaceTableService method instead.

func NewNamespaceTableService

func NewNamespaceTableService(opts ...option.RequestOption) (r *NamespaceTableService)

NewNamespaceTableService 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 (*NamespaceTableService) List

func (r *NamespaceTableService) List(ctx context.Context, bucketName string, namespace string, params NamespaceTableListParams, opts ...option.RequestOption) (res *NamespaceTableListResponse, err error)

Returns a list of tables in the specified namespace within an R2 catalog. Supports pagination for efficient traversal of large table collections.

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 R2DataCatalogDisableParams

type R2DataCatalogDisableParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type R2DataCatalogEnableParams

type R2DataCatalogEnableParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type R2DataCatalogEnableResponse

type R2DataCatalogEnableResponse struct {
	// Use this to uniquely identify the activated catalog.
	ID string `json:"id,required" format:"uuid"`
	// Specifies the name of the activated catalog.
	Name string                          `json:"name,required"`
	JSON r2DataCatalogEnableResponseJSON `json:"-"`
}

Contains response from activating an R2 bucket as a catalog.

func (*R2DataCatalogEnableResponse) UnmarshalJSON

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

type R2DataCatalogEnableResponseEnvelope

type R2DataCatalogEnableResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []R2DataCatalogEnableResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []R2DataCatalogEnableResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Contains response from activating an R2 bucket as a catalog.
	Result R2DataCatalogEnableResponse             `json:"result"`
	JSON   r2DataCatalogEnableResponseEnvelopeJSON `json:"-"`
}

func (*R2DataCatalogEnableResponseEnvelope) UnmarshalJSON

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

type R2DataCatalogEnableResponseEnvelopeErrors

type R2DataCatalogEnableResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                        `json:"message,required"`
	JSON    r2DataCatalogEnableResponseEnvelopeErrorsJSON `json:"-"`
}

func (*R2DataCatalogEnableResponseEnvelopeErrors) UnmarshalJSON

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

type R2DataCatalogEnableResponseEnvelopeMessages

type R2DataCatalogEnableResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                          `json:"message,required"`
	JSON    r2DataCatalogEnableResponseEnvelopeMessagesJSON `json:"-"`
}

func (*R2DataCatalogEnableResponseEnvelopeMessages) UnmarshalJSON

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

type R2DataCatalogGetParams

type R2DataCatalogGetParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type R2DataCatalogGetResponse

type R2DataCatalogGetResponse struct {
	// Use this to uniquely identify the catalog.
	ID string `json:"id,required" format:"uuid"`
	// Specifies the associated R2 bucket name.
	Bucket string `json:"bucket,required"`
	// Specifies the catalog name (generated from account and bucket name).
	Name string `json:"name,required"`
	// Indicates the status of the catalog.
	Status R2DataCatalogGetResponseStatus `json:"status,required"`
	// Shows the credential configuration status.
	CredentialStatus R2DataCatalogGetResponseCredentialStatus `json:"credential_status,nullable"`
	// Configures maintenance for the catalog.
	MaintenanceConfig R2DataCatalogGetResponseMaintenanceConfig `json:"maintenance_config,nullable"`
	JSON              r2DataCatalogGetResponseJSON              `json:"-"`
}

Contains R2 Data Catalog information.

func (*R2DataCatalogGetResponse) UnmarshalJSON

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

type R2DataCatalogGetResponseCredentialStatus

type R2DataCatalogGetResponseCredentialStatus string

Shows the credential configuration status.

const (
	R2DataCatalogGetResponseCredentialStatusPresent R2DataCatalogGetResponseCredentialStatus = "present"
	R2DataCatalogGetResponseCredentialStatusAbsent  R2DataCatalogGetResponseCredentialStatus = "absent"
)

func (R2DataCatalogGetResponseCredentialStatus) IsKnown

type R2DataCatalogGetResponseEnvelope

type R2DataCatalogGetResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []R2DataCatalogGetResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []R2DataCatalogGetResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Contains R2 Data Catalog information.
	Result R2DataCatalogGetResponse             `json:"result"`
	JSON   r2DataCatalogGetResponseEnvelopeJSON `json:"-"`
}

func (*R2DataCatalogGetResponseEnvelope) UnmarshalJSON

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

type R2DataCatalogGetResponseEnvelopeErrors

type R2DataCatalogGetResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                     `json:"message,required"`
	JSON    r2DataCatalogGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*R2DataCatalogGetResponseEnvelopeErrors) UnmarshalJSON

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

type R2DataCatalogGetResponseEnvelopeMessages

type R2DataCatalogGetResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                       `json:"message,required"`
	JSON    r2DataCatalogGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*R2DataCatalogGetResponseEnvelopeMessages) UnmarshalJSON

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

type R2DataCatalogGetResponseMaintenanceConfig

type R2DataCatalogGetResponseMaintenanceConfig struct {
	// Configures compaction for catalog maintenance.
	Compaction R2DataCatalogGetResponseMaintenanceConfigCompaction `json:"compaction"`
	// Configures snapshot expiration settings.
	SnapshotExpiration R2DataCatalogGetResponseMaintenanceConfigSnapshotExpiration `json:"snapshot_expiration"`
	JSON               r2DataCatalogGetResponseMaintenanceConfigJSON               `json:"-"`
}

Configures maintenance for the catalog.

func (*R2DataCatalogGetResponseMaintenanceConfig) UnmarshalJSON

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

type R2DataCatalogGetResponseMaintenanceConfigCompaction

type R2DataCatalogGetResponseMaintenanceConfigCompaction struct {
	// Specifies the state of maintenance operations.
	State R2DataCatalogGetResponseMaintenanceConfigCompactionState `json:"state,required"`
	// Sets the target file size for compaction in megabytes.
	TargetSizeMB R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB `json:"target_size_mb,required"`
	JSON         r2DataCatalogGetResponseMaintenanceConfigCompactionJSON         `json:"-"`
}

Configures compaction for catalog maintenance.

func (*R2DataCatalogGetResponseMaintenanceConfigCompaction) UnmarshalJSON

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

type R2DataCatalogGetResponseMaintenanceConfigCompactionState

type R2DataCatalogGetResponseMaintenanceConfigCompactionState string

Specifies the state of maintenance operations.

const (
	R2DataCatalogGetResponseMaintenanceConfigCompactionStateEnabled  R2DataCatalogGetResponseMaintenanceConfigCompactionState = "enabled"
	R2DataCatalogGetResponseMaintenanceConfigCompactionStateDisabled R2DataCatalogGetResponseMaintenanceConfigCompactionState = "disabled"
)

func (R2DataCatalogGetResponseMaintenanceConfigCompactionState) IsKnown

type R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB

type R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB string

Sets the target file size for compaction in megabytes.

const (
	R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB64  R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB = "64"
	R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB128 R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB = "128"
	R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB256 R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB = "256"
	R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB512 R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB = "512"
)

func (R2DataCatalogGetResponseMaintenanceConfigCompactionTargetSizeMB) IsKnown

type R2DataCatalogGetResponseMaintenanceConfigSnapshotExpiration added in v6.6.0

type R2DataCatalogGetResponseMaintenanceConfigSnapshotExpiration struct {
	// Specifies the maximum age for snapshots. The system deletes snapshots older than
	// this age. Format: <number><unit> where unit is d (days), h (hours), m (minutes),
	// or s (seconds). Examples: "7d" (7 days), "48h" (48 hours), "2880m" (2,880
	// minutes).
	MaxSnapshotAge string `json:"max_snapshot_age,required"`
	// Specifies the minimum number of snapshots to retain.
	MinSnapshotsToKeep int64 `json:"min_snapshots_to_keep,required"`
	// Specifies the state of maintenance operations.
	State R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationState `json:"state,required"`
	JSON  r2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationJSON  `json:"-"`
}

Configures snapshot expiration settings.

func (*R2DataCatalogGetResponseMaintenanceConfigSnapshotExpiration) UnmarshalJSON added in v6.6.0

type R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationState added in v6.6.0

type R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationState string

Specifies the state of maintenance operations.

const (
	R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationStateEnabled  R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationState = "enabled"
	R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationStateDisabled R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationState = "disabled"
)

func (R2DataCatalogGetResponseMaintenanceConfigSnapshotExpirationState) IsKnown added in v6.6.0

type R2DataCatalogGetResponseStatus

type R2DataCatalogGetResponseStatus string

Indicates the status of the catalog.

const (
	R2DataCatalogGetResponseStatusActive   R2DataCatalogGetResponseStatus = "active"
	R2DataCatalogGetResponseStatusInactive R2DataCatalogGetResponseStatus = "inactive"
)

func (R2DataCatalogGetResponseStatus) IsKnown

type R2DataCatalogListParams

type R2DataCatalogListParams struct {
	// Use this to identify the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type R2DataCatalogListResponse

type R2DataCatalogListResponse struct {
	// Lists catalogs in the account.
	Warehouses []R2DataCatalogListResponseWarehouse `json:"warehouses,required"`
	JSON       r2DataCatalogListResponseJSON        `json:"-"`
}

Contains the list of catalogs.

func (*R2DataCatalogListResponse) UnmarshalJSON

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

type R2DataCatalogListResponseEnvelope

type R2DataCatalogListResponseEnvelope struct {
	// Contains errors if the API call was unsuccessful.
	Errors []R2DataCatalogListResponseEnvelopeErrors `json:"errors,required"`
	// Contains informational messages.
	Messages []R2DataCatalogListResponseEnvelopeMessages `json:"messages,required"`
	// Indicates whether the API call was successful.
	Success bool `json:"success,required"`
	// Contains the list of catalogs.
	Result R2DataCatalogListResponse             `json:"result"`
	JSON   r2DataCatalogListResponseEnvelopeJSON `json:"-"`
}

func (*R2DataCatalogListResponseEnvelope) UnmarshalJSON

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

type R2DataCatalogListResponseEnvelopeErrors

type R2DataCatalogListResponseEnvelopeErrors struct {
	// Specifies the error code.
	Code int64 `json:"code,required"`
	// Describes the error.
	Message string                                      `json:"message,required"`
	JSON    r2DataCatalogListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*R2DataCatalogListResponseEnvelopeErrors) UnmarshalJSON

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

type R2DataCatalogListResponseEnvelopeMessages

type R2DataCatalogListResponseEnvelopeMessages struct {
	// Specifies the message code.
	Code int64 `json:"code,required"`
	// Contains the message text.
	Message string                                        `json:"message,required"`
	JSON    r2DataCatalogListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*R2DataCatalogListResponseEnvelopeMessages) UnmarshalJSON

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

type R2DataCatalogListResponseWarehouse

type R2DataCatalogListResponseWarehouse struct {
	// Use this to uniquely identify the catalog.
	ID string `json:"id,required" format:"uuid"`
	// Specifies the associated R2 bucket name.
	Bucket string `json:"bucket,required"`
	// Specifies the catalog name (generated from account and bucket name).
	Name string `json:"name,required"`
	// Indicates the status of the catalog.
	Status R2DataCatalogListResponseWarehousesStatus `json:"status,required"`
	// Shows the credential configuration status.
	CredentialStatus R2DataCatalogListResponseWarehousesCredentialStatus `json:"credential_status,nullable"`
	// Configures maintenance for the catalog.
	MaintenanceConfig R2DataCatalogListResponseWarehousesMaintenanceConfig `json:"maintenance_config,nullable"`
	JSON              r2DataCatalogListResponseWarehouseJSON               `json:"-"`
}

Contains R2 Data Catalog information.

func (*R2DataCatalogListResponseWarehouse) UnmarshalJSON

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

type R2DataCatalogListResponseWarehousesCredentialStatus

type R2DataCatalogListResponseWarehousesCredentialStatus string

Shows the credential configuration status.

const (
	R2DataCatalogListResponseWarehousesCredentialStatusPresent R2DataCatalogListResponseWarehousesCredentialStatus = "present"
	R2DataCatalogListResponseWarehousesCredentialStatusAbsent  R2DataCatalogListResponseWarehousesCredentialStatus = "absent"
)

func (R2DataCatalogListResponseWarehousesCredentialStatus) IsKnown

type R2DataCatalogListResponseWarehousesMaintenanceConfig

type R2DataCatalogListResponseWarehousesMaintenanceConfig struct {
	// Configures compaction for catalog maintenance.
	Compaction R2DataCatalogListResponseWarehousesMaintenanceConfigCompaction `json:"compaction"`
	// Configures snapshot expiration settings.
	SnapshotExpiration R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpiration `json:"snapshot_expiration"`
	JSON               r2DataCatalogListResponseWarehousesMaintenanceConfigJSON               `json:"-"`
}

Configures maintenance for the catalog.

func (*R2DataCatalogListResponseWarehousesMaintenanceConfig) UnmarshalJSON

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

type R2DataCatalogListResponseWarehousesMaintenanceConfigCompaction

type R2DataCatalogListResponseWarehousesMaintenanceConfigCompaction struct {
	// Specifies the state of maintenance operations.
	State R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionState `json:"state,required"`
	// Sets the target file size for compaction in megabytes.
	TargetSizeMB R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB `json:"target_size_mb,required"`
	JSON         r2DataCatalogListResponseWarehousesMaintenanceConfigCompactionJSON         `json:"-"`
}

Configures compaction for catalog maintenance.

func (*R2DataCatalogListResponseWarehousesMaintenanceConfigCompaction) UnmarshalJSON

type R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionState

type R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionState string

Specifies the state of maintenance operations.

const (
	R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionStateEnabled  R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionState = "enabled"
	R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionStateDisabled R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionState = "disabled"
)

func (R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionState) IsKnown

type R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB

type R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB string

Sets the target file size for compaction in megabytes.

const (
	R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB64  R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "64"
	R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB128 R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "128"
	R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB256 R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "256"
	R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB512 R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "512"
)

func (R2DataCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB) IsKnown

type R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpiration added in v6.6.0

type R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpiration struct {
	// Specifies the maximum age for snapshots. The system deletes snapshots older than
	// this age. Format: <number><unit> where unit is d (days), h (hours), m (minutes),
	// or s (seconds). Examples: "7d" (7 days), "48h" (48 hours), "2880m" (2,880
	// minutes).
	MaxSnapshotAge string `json:"max_snapshot_age,required"`
	// Specifies the minimum number of snapshots to retain.
	MinSnapshotsToKeep int64 `json:"min_snapshots_to_keep,required"`
	// Specifies the state of maintenance operations.
	State R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState `json:"state,required"`
	JSON  r2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationJSON  `json:"-"`
}

Configures snapshot expiration settings.

func (*R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpiration) UnmarshalJSON added in v6.6.0

type R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState added in v6.6.0

type R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState string

Specifies the state of maintenance operations.

const (
	R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationStateEnabled  R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState = "enabled"
	R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationStateDisabled R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState = "disabled"
)

func (R2DataCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState) IsKnown added in v6.6.0

type R2DataCatalogListResponseWarehousesStatus

type R2DataCatalogListResponseWarehousesStatus string

Indicates the status of the catalog.

const (
	R2DataCatalogListResponseWarehousesStatusActive   R2DataCatalogListResponseWarehousesStatus = "active"
	R2DataCatalogListResponseWarehousesStatusInactive R2DataCatalogListResponseWarehousesStatus = "inactive"
)

func (R2DataCatalogListResponseWarehousesStatus) IsKnown

type R2DataCatalogService

type R2DataCatalogService struct {
	Options            []option.RequestOption
	MaintenanceConfigs *MaintenanceConfigService
	Credentials        *CredentialService
	Namespaces         *NamespaceService
}

R2DataCatalogService 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 NewR2DataCatalogService method instead.

func NewR2DataCatalogService

func NewR2DataCatalogService(opts ...option.RequestOption) (r *R2DataCatalogService)

NewR2DataCatalogService 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 (*R2DataCatalogService) Disable

func (r *R2DataCatalogService) Disable(ctx context.Context, bucketName string, body R2DataCatalogDisableParams, opts ...option.RequestOption) (err error)

Disable an R2 bucket as a catalog. This operation deactivates the catalog but preserves existing metadata and data files. The catalog can be re-enabled later.

func (*R2DataCatalogService) Enable

Enable an R2 bucket as an Apache Iceberg catalog. This operation creates the necessary catalog infrastructure and activates the bucket for storing Iceberg metadata and data files.

func (*R2DataCatalogService) Get

Retrieve detailed information about a specific R2 catalog by bucket name. Returns catalog status, maintenance configuration, and credential status.

func (*R2DataCatalogService) List

Returns a list of R2 buckets that have been enabled as Apache Iceberg catalogs for the specified account. Each catalog represents an R2 bucket configured to store Iceberg metadata and data files.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

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 ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

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 SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

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 TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL