containers

package
v7.13.0 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 2026 License: Apache-2.0 Imports: 17 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 ApplicationDeleteParams

type ApplicationDeleteParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ApplicationDeleteResponse

type ApplicationDeleteResponse struct {
	Message string                        `json:"message" api:"required"`
	JSON    applicationDeleteResponseJSON `json:"-"`
}

Result of starting asynchronous deletion for a Containers application.

func (*ApplicationDeleteResponse) UnmarshalJSON

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

type ApplicationDeleteResponseEnvelope

type ApplicationDeleteResponseEnvelope struct {
	Errors   []ApplicationDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ApplicationDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Result of starting asynchronous deletion for a Containers application.
	Result ApplicationDeleteResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                                  `json:"success" api:"required"`
	JSON    applicationDeleteResponseEnvelopeJSON `json:"-"`
}

func (*ApplicationDeleteResponseEnvelope) UnmarshalJSON

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

type ApplicationDeleteResponseEnvelopeErrors

type ApplicationDeleteResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code" api:"required"`
	Message          string                                        `json:"message" api:"required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           ApplicationDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             applicationDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ApplicationDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type ApplicationDeleteResponseEnvelopeErrorsSource

type ApplicationDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    applicationDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ApplicationDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ApplicationDeleteResponseEnvelopeMessages

type ApplicationDeleteResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ApplicationDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             applicationDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ApplicationDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type ApplicationDeleteResponseEnvelopeMessagesSource

type ApplicationDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    applicationDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ApplicationDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ApplicationEditParams

type ApplicationEditParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Application configuration fields you can change without creating a rollout.
	Configuration param.Field[ApplicationEditParamsConfiguration] `json:"configuration"`
	Constraints   param.Field[ApplicationEditParamsConstraints]   `json:"constraints"`
	// Maximum number of instances that an autoscaling application can run.
	MaxInstances param.Field[int64] `json:"max_instances"`
	// Top-level application observability settings. Scheduler-backed applications
	// hot-reload these settings across existing instances. An existing Durable
	// Object-managed application accepts only `logs.enabled` and publishes these
	// settings to runtime metadata without creating deployments or rollouts.
	Observability param.Field[ApplicationEditParamsObservability] `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod param.Field[int64] `json:"rollout_active_grace_period"`
}

func (ApplicationEditParams) MarshalJSON

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

type ApplicationEditParamsConfiguration

type ApplicationEditParamsConfiguration struct {
	AuthorizedKeys param.Field[[]ApplicationEditParamsConfigurationAuthorizedKey] `json:"authorized_keys"`
	// Configuration properties for connecting with SSH to a container using Wrangler.
	WranglerSSH param.Field[ApplicationEditParamsConfigurationWranglerSSH] `json:"wrangler_ssh"`
}

Application configuration fields you can change without creating a rollout.

func (ApplicationEditParamsConfiguration) MarshalJSON

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

type ApplicationEditParamsConfigurationAuthorizedKey

type ApplicationEditParamsConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey param.Field[string] `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name param.Field[string] `json:"name"`
}

User-provided SSH public key.

func (ApplicationEditParamsConfigurationAuthorizedKey) MarshalJSON

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

type ApplicationEditParamsConfigurationWranglerSSH

type ApplicationEditParamsConfigurationWranglerSSH struct {
	Enabled param.Field[bool]  `json:"enabled"`
	Port    param.Field[int64] `json:"port"`
}

Configuration properties for connecting with SSH to a container using Wrangler.

func (ApplicationEditParamsConfigurationWranglerSSH) MarshalJSON

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

type ApplicationEditParamsConstraints

type ApplicationEditParamsConstraints struct {
	// Restricts placement to datacenters in the selected jurisdiction. Choose "eu",
	// "fedramp", or "us". When combined with regions, EU supports EEUR and WEUR while
	// FedRAMP and US support ENAM and WNAM.
	Jurisdiction param.Field[string]   `json:"jurisdiction"`
	Regions      param.Field[[]string] `json:"regions"`
}

func (ApplicationEditParamsConstraints) MarshalJSON

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

type ApplicationEditParamsObservability

type ApplicationEditParamsObservability struct {
	// Observability logging settings.
	Logs param.Field[ApplicationEditParamsObservabilityLogs] `json:"logs"`
}

Top-level application observability settings. Scheduler-backed applications hot-reload these settings across existing instances. An existing Durable Object-managed application accepts only `logs.enabled` and publishes these settings to runtime metadata without creating deployments or rollouts.

func (ApplicationEditParamsObservability) MarshalJSON

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

type ApplicationEditParamsObservabilityLogs

type ApplicationEditParamsObservabilityLogs struct {
	Enabled param.Field[bool] `json:"enabled"`
}

Observability logging settings.

func (ApplicationEditParamsObservabilityLogs) MarshalJSON

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

type ApplicationEditResponse

type ApplicationEditResponse struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationEditResponseSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string `json:"active_rollout_id"`
	// This field can have the runtime type of
	// [ApplicationEditResponseCcScheduledApplicationConfiguration],
	// [ApplicationEditResponseCcDurableObjectApplicationConfiguration].
	Configuration interface{} `json:"configuration"`
	// This field can have the runtime type of
	// [ApplicationEditResponseCcScheduledApplicationConstraints].
	Constraints interface{} `json:"constraints"`
	// This field can have the runtime type of
	// [ApplicationEditResponseCcScheduledApplicationDurableObjects],
	// [ApplicationEditResponseCcDurableObjectApplicationDurableObjects].
	DurableObjects interface{} `json:"durable_objects"`
	// This field can have the runtime type of
	// [ApplicationEditResponseCcScheduledApplicationHealth],
	// [ApplicationEditResponseCcDurableObjectApplicationHealth].
	Health interface{} `json:"health"`
	// Number of deployments to create.
	Instances int64 `json:"instances"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// This field can have the runtime type of
	// [ApplicationEditResponseCcScheduledApplicationObservability],
	// [ApplicationEditResponseCcDurableObjectApplicationObservability].
	Observability interface{} `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                       `json:"rollout_active_grace_period"`
	Version                  int64                       `json:"version"`
	JSON                     applicationEditResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

The public Containers API returns an application.

func (ApplicationEditResponse) AsUnion

AsUnion returns a ApplicationEditResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are ApplicationEditResponseCcScheduledApplication, ApplicationEditResponseCcDurableObjectApplication.

func (*ApplicationEditResponse) UnmarshalJSON

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

type ApplicationEditResponseCcDurableObjectApplication

type ApplicationEditResponseCcDurableObjectApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Durable object configuration using a namespace ID.
	DurableObjects ApplicationEditResponseCcDurableObjectApplicationDurableObjects `json:"durable_objects" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// Selects a Durable Object-managed application. Each Durable Object creates and
	// manages the lifecycle of its container instance. Configure application-wide
	// observability settings here. Deployment configuration, scaling, placement
	// constraints, versions, and rollouts do not apply.
	SchedulingPolicy ApplicationEditResponseCcDurableObjectApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// Application-wide settings for a Durable Object-managed application.
	Configuration ApplicationEditResponseCcDurableObjectApplicationConfiguration `json:"configuration"`
	// Aggregate current activity for the latest observed placement of each instance.
	// Runtime snapshots feed periodic background sweeps. Counts refresh after each
	// complete sweep. Instance listings retain their separate three-month history for
	// failure discovery.
	Health ApplicationEditResponseCcDurableObjectApplicationHealth `json:"health"`
	// Application-wide logging settings for a Durable Object-managed application. The
	// application publishes these settings to its runtime metadata. Updating them does
	// not create a deployment or rollout.
	Observability ApplicationEditResponseCcDurableObjectApplicationObservability `json:"observability"`
	JSON          applicationEditResponseCcDurableObjectApplicationJSON          `json:"-"`
}

Each Durable Object creates and manages the lifecycle of its container instance.

func (*ApplicationEditResponseCcDurableObjectApplication) UnmarshalJSON

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

type ApplicationEditResponseCcDurableObjectApplicationConfiguration

type ApplicationEditResponseCcDurableObjectApplicationConfiguration struct {
	AuthorizedKeys []ApplicationEditResponseCcDurableObjectApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// Configuration properties for connecting with SSH to a container using Wrangler.
	WranglerSSH ApplicationEditResponseCcDurableObjectApplicationConfigurationWranglerSSH `json:"wrangler_ssh"`
	JSON        applicationEditResponseCcDurableObjectApplicationConfigurationJSON        `json:"-"`
}

Application-wide settings for a Durable Object-managed application.

func (*ApplicationEditResponseCcDurableObjectApplicationConfiguration) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationConfigurationAuthorizedKey

type ApplicationEditResponseCcDurableObjectApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                          `json:"name"`
	JSON applicationEditResponseCcDurableObjectApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationEditResponseCcDurableObjectApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationConfigurationWranglerSSH

type ApplicationEditResponseCcDurableObjectApplicationConfigurationWranglerSSH struct {
	Enabled bool                                                                          `json:"enabled"`
	Port    int64                                                                         `json:"port"`
	JSON    applicationEditResponseCcDurableObjectApplicationConfigurationWranglerSSHJSON `json:"-"`
}

Configuration properties for connecting with SSH to a container using Wrangler.

func (*ApplicationEditResponseCcDurableObjectApplicationConfigurationWranglerSSH) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationDurableObjects

type ApplicationEditResponseCcDurableObjectApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                              `json:"namespace_id" api:"required"`
	JSON        applicationEditResponseCcDurableObjectApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration using a namespace ID.

func (*ApplicationEditResponseCcDurableObjectApplicationDurableObjects) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationHealth

type ApplicationEditResponseCcDurableObjectApplicationHealth struct {
	// Counts of observed non-terminal instances.
	Instances ApplicationEditResponseCcDurableObjectApplicationHealthInstances `json:"instances" api:"required"`
	// Present as pending until the first activity sweep completes; omitted afterward.
	Summary ApplicationEditResponseCcDurableObjectApplicationHealthSummary `json:"summary"`
	JSON    applicationEditResponseCcDurableObjectApplicationHealthJSON    `json:"-"`
}

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

func (*ApplicationEditResponseCcDurableObjectApplicationHealth) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationHealthInstances

type ApplicationEditResponseCcDurableObjectApplicationHealthInstances struct {
	// Number of instances whose runtime reports running or stopping.
	Active int64 `json:"active" api:"required"`
	// Number of instances whose runtime reports starting.
	Starting int64                                                                `json:"starting" api:"required"`
	JSON     applicationEditResponseCcDurableObjectApplicationHealthInstancesJSON `json:"-"`
}

Counts of observed non-terminal instances.

func (*ApplicationEditResponseCcDurableObjectApplicationHealthInstances) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationHealthSummary

type ApplicationEditResponseCcDurableObjectApplicationHealthSummary string

Present as pending until the first activity sweep completes; omitted afterward.

const (
	ApplicationEditResponseCcDurableObjectApplicationHealthSummaryPending ApplicationEditResponseCcDurableObjectApplicationHealthSummary = "pending"
)

func (ApplicationEditResponseCcDurableObjectApplicationHealthSummary) IsKnown

type ApplicationEditResponseCcDurableObjectApplicationObservability

type ApplicationEditResponseCcDurableObjectApplicationObservability struct {
	// Application-wide logging settings.
	Logs ApplicationEditResponseCcDurableObjectApplicationObservabilityLogs `json:"logs"`
	JSON applicationEditResponseCcDurableObjectApplicationObservabilityJSON `json:"-"`
}

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

func (*ApplicationEditResponseCcDurableObjectApplicationObservability) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationObservabilityLogs

type ApplicationEditResponseCcDurableObjectApplicationObservabilityLogs struct {
	Enabled bool                                                                   `json:"enabled"`
	JSON    applicationEditResponseCcDurableObjectApplicationObservabilityLogsJSON `json:"-"`
}

Application-wide logging settings.

func (*ApplicationEditResponseCcDurableObjectApplicationObservabilityLogs) UnmarshalJSON

type ApplicationEditResponseCcDurableObjectApplicationSchedulingPolicy

type ApplicationEditResponseCcDurableObjectApplicationSchedulingPolicy string

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

const (
	ApplicationEditResponseCcDurableObjectApplicationSchedulingPolicyDurableObject ApplicationEditResponseCcDurableObjectApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationEditResponseCcDurableObjectApplicationSchedulingPolicy) IsKnown

type ApplicationEditResponseCcScheduledApplication

type ApplicationEditResponseCcScheduledApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// User-specified container configuration.
	Configuration ApplicationEditResponseCcScheduledApplicationConfiguration `json:"configuration" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Number of deployments to create.
	Instances int64 `json:"instances" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationEditResponseCcScheduledApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	Version   int64  `json:"version" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string                                                   `json:"active_rollout_id"`
	Constraints     ApplicationEditResponseCcScheduledApplicationConstraints `json:"constraints"`
	// Durable object configuration stored on and returned from a Cloudchamber
	// application.
	DurableObjects ApplicationEditResponseCcScheduledApplicationDurableObjects `json:"durable_objects"`
	Health         ApplicationEditResponseCcScheduledApplicationHealth         `json:"health"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// Top-level observability settings for the application. This field is mutually
	// exclusive with configuration.observability.
	Observability ApplicationEditResponseCcScheduledApplicationObservability `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                                             `json:"rollout_active_grace_period"`
	JSON                     applicationEditResponseCcScheduledApplicationJSON `json:"-"`
}

Describes an application and the parameters that govern how it places its instances.

func (*ApplicationEditResponseCcScheduledApplication) UnmarshalJSON

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

type ApplicationEditResponseCcScheduledApplicationConfiguration

type ApplicationEditResponseCcScheduledApplicationConfiguration struct {
	// Image url.
	Image          string                                                                    `json:"image" api:"required"`
	AuthorizedKeys []ApplicationEditResponseCcScheduledApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command []string `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint []string `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables []ApplicationEditResponseCcScheduledApplicationConfigurationEnvironmentVariable `json:"environment_variables"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability ApplicationEditResponseCcScheduledApplicationConfigurationObservability `json:"observability"`
	JSON          applicationEditResponseCcScheduledApplicationConfigurationJSON          `json:"-"`
}

User-specified container configuration.

func (*ApplicationEditResponseCcScheduledApplicationConfiguration) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationConfigurationAuthorizedKey

type ApplicationEditResponseCcScheduledApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                      `json:"name"`
	JSON applicationEditResponseCcScheduledApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationEditResponseCcScheduledApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationConfigurationEnvironmentVariable

type ApplicationEditResponseCcScheduledApplicationConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name string `json:"name" api:"required"`
	// An environment variable value.
	Value string                                                                            `json:"value" api:"required"`
	JSON  applicationEditResponseCcScheduledApplicationConfigurationEnvironmentVariableJSON `json:"-"`
}

An environment variable with a value set.

func (*ApplicationEditResponseCcScheduledApplicationConfigurationEnvironmentVariable) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType

type ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationEditResponseCcScheduledApplicationConfigurationInstanceTypeLite      ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType = "lite"
	ApplicationEditResponseCcScheduledApplicationConfigurationInstanceTypeBasic     ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType = "basic"
	ApplicationEditResponseCcScheduledApplicationConfigurationInstanceTypeStandard1 ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType = "standard-1"
	ApplicationEditResponseCcScheduledApplicationConfigurationInstanceTypeStandard2 ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType = "standard-2"
	ApplicationEditResponseCcScheduledApplicationConfigurationInstanceTypeStandard3 ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType = "standard-3"
	ApplicationEditResponseCcScheduledApplicationConfigurationInstanceTypeStandard4 ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType = "standard-4"
)

func (ApplicationEditResponseCcScheduledApplicationConfigurationInstanceType) IsKnown

type ApplicationEditResponseCcScheduledApplicationConfigurationObservability

type ApplicationEditResponseCcScheduledApplicationConfigurationObservability struct {
	// Observability logging settings.
	Logs ApplicationEditResponseCcScheduledApplicationConfigurationObservabilityLogs `json:"logs"`
	JSON applicationEditResponseCcScheduledApplicationConfigurationObservabilityJSON `json:"-"`
}

Settings for deployment observability such as logging.

func (*ApplicationEditResponseCcScheduledApplicationConfigurationObservability) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationConfigurationObservabilityLogs

type ApplicationEditResponseCcScheduledApplicationConfigurationObservabilityLogs struct {
	Enabled bool                                                                            `json:"enabled"`
	JSON    applicationEditResponseCcScheduledApplicationConfigurationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationEditResponseCcScheduledApplicationConfigurationObservabilityLogs) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationConstraints

type ApplicationEditResponseCcScheduledApplicationConstraints struct {
	// Restricts placement to datacenters in the selected jurisdiction. Choose "eu",
	// "fedramp", or "us". When combined with regions, EU supports EEUR and WEUR while
	// FedRAMP and US support ENAM and WNAM.
	Jurisdiction string                                                       `json:"jurisdiction"`
	Regions      []string                                                     `json:"regions"`
	JSON         applicationEditResponseCcScheduledApplicationConstraintsJSON `json:"-"`
}

func (*ApplicationEditResponseCcScheduledApplicationConstraints) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationDurableObjects

type ApplicationEditResponseCcScheduledApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                          `json:"namespace_id" api:"required"`
	JSON        applicationEditResponseCcScheduledApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration stored on and returned from a Cloudchamber application.

func (*ApplicationEditResponseCcScheduledApplicationDurableObjects) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationHealth

type ApplicationEditResponseCcScheduledApplicationHealth struct {
	Errors []ApplicationEditResponseCcScheduledApplicationHealthError `json:"errors" api:"required"`
	// Shows a count of application instance states.
	Instances ApplicationEditResponseCcScheduledApplicationHealthInstances `json:"instances" api:"required"`
	// High-level health assessment. Only populated for "new_instances" strategy. Based
	// on a sample of target-version instances rather than a full count.
	//
	// - "pending": Zero target-version instances exist yet.
	// - "healthy": Every sampled target-version instance reports running or active.
	// - "degraded": Some sampled instances remain starting or scheduling.
	// - "unhealthy": One or more sampled instances have failed.
	Summary ApplicationEditResponseCcScheduledApplicationHealthSummary `json:"summary"`
	JSON    applicationEditResponseCcScheduledApplicationHealthJSON    `json:"-"`
}

func (*ApplicationEditResponseCcScheduledApplicationHealth) UnmarshalJSON

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

type ApplicationEditResponseCcScheduledApplicationHealthError

type ApplicationEditResponseCcScheduledApplicationHealthError struct {
	// An event within a Placement or a Job.
	Event ApplicationEditResponseCcScheduledApplicationHealthErrorsEvent `json:"event" api:"required"`
	// An instance ID represents an identifier of an instance configuration that
	// maintains an underlying placement.
	InstanceID string                                                       `json:"instance_id" api:"required"`
	JSON       applicationEditResponseCcScheduledApplicationHealthErrorJSON `json:"-"`
}

func (*ApplicationEditResponseCcScheduledApplicationHealthError) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationHealthErrorsEvent

type ApplicationEditResponseCcScheduledApplicationHealthErrorsEvent struct {
	ID      string                 `json:"id" api:"required"`
	Details map[string]interface{} `json:"details" api:"required"`
	Message string                 `json:"message" api:"required"`
	// Name of the event that describes the kind event that happened.
	//
	//   - SchedulerPlaced: It's the first event that creates a container placement. It
	//     happens when the Containers runtime was able to retrieve deployment resources
	//     and start verifying everything is correct.
	//   - NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the
	//     container.
	//   - VMStarted: It's sent when the Containers runtime starts the VM. The container
	//     might remain unhealthy at this point.
	//   - ImagePulled: It's sent when the Containers runtime pulls the image
	//     successfully.
	//   - ImagePullError: It's sent when the Containers runtime is having issues pulling
	//     the image. The message and details have more information on what happened for
	//     debugging.
	//   - VMFailedToStart: It's sent when the Containers runtime was unable to boot the
	//     VM.
	//   - VMStopping: It's sent when the scheduler is stopping the VM.
	//   - VMStopped: It's sent when the VM finally exits.
	//   - VMFailed: It's sent when the scheduling of the VM failed in the current
	//     location.
	//   - RuntimeStartFailed: It's sent when the runtime hits an internal error.
	//   - SSHStarted: It's sent when the container gains network connectivity and opens
	//     the SSH port. Containers only send this event when SSH keys exist.
	//   - CheckUpdate: Sent when the status of a health or readiness check changes. This
	//     may also affect the health status of the placement.
	//   - DurableObjectConnected: Sent when a durable object instance connects and gains
	//     control of the deployment. This event is only sent for durable object
	//     deployments. It is sent after VMStarted.
	//   - ContainerStarted: It's sent when the container starts running.
	Name         ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName `json:"name" api:"required"`
	StatusChange map[string]interface{}                                             `json:"statusChange" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	Time string                                                             `json:"time" api:"required"`
	Type ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType `json:"type" api:"required"`
	JSON applicationEditResponseCcScheduledApplicationHealthErrorsEventJSON `json:"-"`
}

An event within a Placement or a Job.

func (*ApplicationEditResponseCcScheduledApplicationHealthErrorsEvent) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName

type ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName string

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It's the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the container.
  • VMStarted: It's sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It's sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It's sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It's sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It's sent when the scheduler is stopping the VM.
  • VMStopped: It's sent when the VM finally exits.
  • VMFailed: It's sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It's sent when the runtime hits an internal error.
  • SSHStarted: It's sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It's sent when the container starts running.
const (
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameSchedulerPlaced              ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "SchedulerPlaced"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssigned         ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssigned"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameVmStarted                    ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "VMStarted"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameImagePulled                  ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "ImagePulled"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameImagePullError               ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "ImagePullError"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameVmFailedToStart              ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "VMFailedToStart"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssignmentFailed ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssignmentFailed"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameVmRunning                    ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "VMRunning"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameVmStopping                   ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "VMStopping"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameVmStopped                    ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "VMStopped"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameVmFailed                     ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "VMFailed"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameRuntimeStartFailed           ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "RuntimeStartFailed"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameSSHStarted                   ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "SSHStarted"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameServiceHealthUpdates         ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "ServiceHealthUpdates"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameCheckUpdate                  ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "CheckUpdate"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameDurableObjectConnected       ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "DurableObjectConnected"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventNameContainerStarted             ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName = "ContainerStarted"
)

func (ApplicationEditResponseCcScheduledApplicationHealthErrorsEventName) IsKnown

type ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType

type ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType string
const (
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventTypeInfo        ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType = "Info"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventTypeError       ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType = "Error"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventTypeWarn        ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType = "Warn"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventTypeUserError   ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType = "UserError"
	ApplicationEditResponseCcScheduledApplicationHealthErrorsEventTypeSystemError ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType = "SystemError"
)

func (ApplicationEditResponseCcScheduledApplicationHealthErrorsEventType) IsKnown

type ApplicationEditResponseCcScheduledApplicationHealthInstances

type ApplicationEditResponseCcScheduledApplicationHealthInstances struct {
	// Number of instances whose runtime reports the container as running
	// (container_status = "running"). This is a subset of the placements that remain
	// up: an instance that is already bound to a Durable Object and serving traffic is
	// counted under "assigned" until its container_status catches up to "running", so
	// container_status can briefly lag Durable Object attachment under churn. To
	// estimate running, Durable-Object-bound instances, sum "active" + "assigned"
	// rather than reading "active" alone.
	Active int64 `json:"active" api:"required"`
	// Number of instances bound to a Durable Object with a running placement whose
	// container_status remains behind "running". These count as live, serving
	// instances; "active" + "assigned" approximates the running, Durable-Object-bound
	// count.
	Assigned int64                                                            `json:"assigned" api:"required"`
	JSON     applicationEditResponseCcScheduledApplicationHealthInstancesJSON `json:"-"`
}

Shows a count of application instance states.

func (*ApplicationEditResponseCcScheduledApplicationHealthInstances) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationHealthSummary

type ApplicationEditResponseCcScheduledApplicationHealthSummary string

High-level health assessment. Only populated for "new_instances" strategy. Based on a sample of target-version instances rather than a full count.

- "pending": Zero target-version instances exist yet. - "healthy": Every sampled target-version instance reports running or active. - "degraded": Some sampled instances remain starting or scheduling. - "unhealthy": One or more sampled instances have failed.

const (
	ApplicationEditResponseCcScheduledApplicationHealthSummaryHealthy   ApplicationEditResponseCcScheduledApplicationHealthSummary = "healthy"
	ApplicationEditResponseCcScheduledApplicationHealthSummaryDegraded  ApplicationEditResponseCcScheduledApplicationHealthSummary = "degraded"
	ApplicationEditResponseCcScheduledApplicationHealthSummaryUnhealthy ApplicationEditResponseCcScheduledApplicationHealthSummary = "unhealthy"
	ApplicationEditResponseCcScheduledApplicationHealthSummaryPending   ApplicationEditResponseCcScheduledApplicationHealthSummary = "pending"
)

func (ApplicationEditResponseCcScheduledApplicationHealthSummary) IsKnown

type ApplicationEditResponseCcScheduledApplicationObservability

type ApplicationEditResponseCcScheduledApplicationObservability struct {
	// Observability logging settings.
	Logs ApplicationEditResponseCcScheduledApplicationObservabilityLogs `json:"logs"`
	JSON applicationEditResponseCcScheduledApplicationObservabilityJSON `json:"-"`
}

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

func (*ApplicationEditResponseCcScheduledApplicationObservability) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationObservabilityLogs

type ApplicationEditResponseCcScheduledApplicationObservabilityLogs struct {
	Enabled bool                                                               `json:"enabled"`
	JSON    applicationEditResponseCcScheduledApplicationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationEditResponseCcScheduledApplicationObservabilityLogs) UnmarshalJSON

type ApplicationEditResponseCcScheduledApplicationSchedulingPolicy

type ApplicationEditResponseCcScheduledApplicationSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationEditResponseCcScheduledApplicationSchedulingPolicyDefault       ApplicationEditResponseCcScheduledApplicationSchedulingPolicy = "default"
	ApplicationEditResponseCcScheduledApplicationSchedulingPolicyDurableObject ApplicationEditResponseCcScheduledApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationEditResponseCcScheduledApplicationSchedulingPolicy) IsKnown

type ApplicationEditResponseEnvelope

type ApplicationEditResponseEnvelope struct {
	Errors   []ApplicationEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ApplicationEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// The public Containers API returns an application.
	Result ApplicationEditResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                                `json:"success" api:"required"`
	JSON    applicationEditResponseEnvelopeJSON `json:"-"`
}

func (*ApplicationEditResponseEnvelope) UnmarshalJSON

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

type ApplicationEditResponseEnvelopeErrors

type ApplicationEditResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code" api:"required"`
	Message          string                                      `json:"message" api:"required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           ApplicationEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             applicationEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ApplicationEditResponseEnvelopeErrors) UnmarshalJSON

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

type ApplicationEditResponseEnvelopeErrorsSource

type ApplicationEditResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    applicationEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ApplicationEditResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ApplicationEditResponseEnvelopeMessages

type ApplicationEditResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code" api:"required"`
	Message          string                                        `json:"message" api:"required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           ApplicationEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             applicationEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ApplicationEditResponseEnvelopeMessages) UnmarshalJSON

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

type ApplicationEditResponseEnvelopeMessagesSource

type ApplicationEditResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    applicationEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ApplicationEditResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ApplicationEditResponseSchedulingPolicy

type ApplicationEditResponseSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationEditResponseSchedulingPolicyDefault       ApplicationEditResponseSchedulingPolicy = "default"
	ApplicationEditResponseSchedulingPolicyDurableObject ApplicationEditResponseSchedulingPolicy = "durable_object"
)

func (ApplicationEditResponseSchedulingPolicy) IsKnown

type ApplicationEditResponseUnion

type ApplicationEditResponseUnion interface {
	// contains filtered or unexported methods
}

The public Containers API returns an application.

Union satisfied by ApplicationEditResponseCcScheduledApplication or ApplicationEditResponseCcDurableObjectApplication.

type ApplicationGetParams

type ApplicationGetParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ApplicationGetResponse

type ApplicationGetResponse struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationGetResponseSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string `json:"active_rollout_id"`
	// This field can have the runtime type of
	// [ApplicationGetResponseCcScheduledApplicationConfiguration],
	// [ApplicationGetResponseCcDurableObjectApplicationConfiguration].
	Configuration interface{} `json:"configuration"`
	// This field can have the runtime type of
	// [ApplicationGetResponseCcScheduledApplicationConstraints].
	Constraints interface{} `json:"constraints"`
	// This field can have the runtime type of
	// [ApplicationGetResponseCcScheduledApplicationDurableObjects],
	// [ApplicationGetResponseCcDurableObjectApplicationDurableObjects].
	DurableObjects interface{} `json:"durable_objects"`
	// This field can have the runtime type of
	// [ApplicationGetResponseCcScheduledApplicationHealth],
	// [ApplicationGetResponseCcDurableObjectApplicationHealth].
	Health interface{} `json:"health"`
	// Number of deployments to create.
	Instances int64 `json:"instances"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// This field can have the runtime type of
	// [ApplicationGetResponseCcScheduledApplicationObservability],
	// [ApplicationGetResponseCcDurableObjectApplicationObservability].
	Observability interface{} `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                      `json:"rollout_active_grace_period"`
	Version                  int64                      `json:"version"`
	JSON                     applicationGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

The public Containers API returns an application.

func (ApplicationGetResponse) AsUnion

AsUnion returns a ApplicationGetResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are ApplicationGetResponseCcScheduledApplication, ApplicationGetResponseCcDurableObjectApplication.

func (*ApplicationGetResponse) UnmarshalJSON

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

type ApplicationGetResponseCcDurableObjectApplication

type ApplicationGetResponseCcDurableObjectApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Durable object configuration using a namespace ID.
	DurableObjects ApplicationGetResponseCcDurableObjectApplicationDurableObjects `json:"durable_objects" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// Selects a Durable Object-managed application. Each Durable Object creates and
	// manages the lifecycle of its container instance. Configure application-wide
	// observability settings here. Deployment configuration, scaling, placement
	// constraints, versions, and rollouts do not apply.
	SchedulingPolicy ApplicationGetResponseCcDurableObjectApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// Application-wide settings for a Durable Object-managed application.
	Configuration ApplicationGetResponseCcDurableObjectApplicationConfiguration `json:"configuration"`
	// Aggregate current activity for the latest observed placement of each instance.
	// Runtime snapshots feed periodic background sweeps. Counts refresh after each
	// complete sweep. Instance listings retain their separate three-month history for
	// failure discovery.
	Health ApplicationGetResponseCcDurableObjectApplicationHealth `json:"health"`
	// Application-wide logging settings for a Durable Object-managed application. The
	// application publishes these settings to its runtime metadata. Updating them does
	// not create a deployment or rollout.
	Observability ApplicationGetResponseCcDurableObjectApplicationObservability `json:"observability"`
	JSON          applicationGetResponseCcDurableObjectApplicationJSON          `json:"-"`
}

Each Durable Object creates and manages the lifecycle of its container instance.

func (*ApplicationGetResponseCcDurableObjectApplication) UnmarshalJSON

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

type ApplicationGetResponseCcDurableObjectApplicationConfiguration

type ApplicationGetResponseCcDurableObjectApplicationConfiguration struct {
	AuthorizedKeys []ApplicationGetResponseCcDurableObjectApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// Configuration properties for connecting with SSH to a container using Wrangler.
	WranglerSSH ApplicationGetResponseCcDurableObjectApplicationConfigurationWranglerSSH `json:"wrangler_ssh"`
	JSON        applicationGetResponseCcDurableObjectApplicationConfigurationJSON        `json:"-"`
}

Application-wide settings for a Durable Object-managed application.

func (*ApplicationGetResponseCcDurableObjectApplicationConfiguration) UnmarshalJSON

type ApplicationGetResponseCcDurableObjectApplicationConfigurationAuthorizedKey

type ApplicationGetResponseCcDurableObjectApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                         `json:"name"`
	JSON applicationGetResponseCcDurableObjectApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationGetResponseCcDurableObjectApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationGetResponseCcDurableObjectApplicationConfigurationWranglerSSH

type ApplicationGetResponseCcDurableObjectApplicationConfigurationWranglerSSH struct {
	Enabled bool                                                                         `json:"enabled"`
	Port    int64                                                                        `json:"port"`
	JSON    applicationGetResponseCcDurableObjectApplicationConfigurationWranglerSSHJSON `json:"-"`
}

Configuration properties for connecting with SSH to a container using Wrangler.

func (*ApplicationGetResponseCcDurableObjectApplicationConfigurationWranglerSSH) UnmarshalJSON

type ApplicationGetResponseCcDurableObjectApplicationDurableObjects

type ApplicationGetResponseCcDurableObjectApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                             `json:"namespace_id" api:"required"`
	JSON        applicationGetResponseCcDurableObjectApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration using a namespace ID.

func (*ApplicationGetResponseCcDurableObjectApplicationDurableObjects) UnmarshalJSON

type ApplicationGetResponseCcDurableObjectApplicationHealth

type ApplicationGetResponseCcDurableObjectApplicationHealth struct {
	// Counts of observed non-terminal instances.
	Instances ApplicationGetResponseCcDurableObjectApplicationHealthInstances `json:"instances" api:"required"`
	// Present as pending until the first activity sweep completes; omitted afterward.
	Summary ApplicationGetResponseCcDurableObjectApplicationHealthSummary `json:"summary"`
	JSON    applicationGetResponseCcDurableObjectApplicationHealthJSON    `json:"-"`
}

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

func (*ApplicationGetResponseCcDurableObjectApplicationHealth) UnmarshalJSON

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

type ApplicationGetResponseCcDurableObjectApplicationHealthInstances

type ApplicationGetResponseCcDurableObjectApplicationHealthInstances struct {
	// Number of instances whose runtime reports running or stopping.
	Active int64 `json:"active" api:"required"`
	// Number of instances whose runtime reports starting.
	Starting int64                                                               `json:"starting" api:"required"`
	JSON     applicationGetResponseCcDurableObjectApplicationHealthInstancesJSON `json:"-"`
}

Counts of observed non-terminal instances.

func (*ApplicationGetResponseCcDurableObjectApplicationHealthInstances) UnmarshalJSON

type ApplicationGetResponseCcDurableObjectApplicationHealthSummary

type ApplicationGetResponseCcDurableObjectApplicationHealthSummary string

Present as pending until the first activity sweep completes; omitted afterward.

const (
	ApplicationGetResponseCcDurableObjectApplicationHealthSummaryPending ApplicationGetResponseCcDurableObjectApplicationHealthSummary = "pending"
)

func (ApplicationGetResponseCcDurableObjectApplicationHealthSummary) IsKnown

type ApplicationGetResponseCcDurableObjectApplicationObservability

type ApplicationGetResponseCcDurableObjectApplicationObservability struct {
	// Application-wide logging settings.
	Logs ApplicationGetResponseCcDurableObjectApplicationObservabilityLogs `json:"logs"`
	JSON applicationGetResponseCcDurableObjectApplicationObservabilityJSON `json:"-"`
}

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

func (*ApplicationGetResponseCcDurableObjectApplicationObservability) UnmarshalJSON

type ApplicationGetResponseCcDurableObjectApplicationObservabilityLogs

type ApplicationGetResponseCcDurableObjectApplicationObservabilityLogs struct {
	Enabled bool                                                                  `json:"enabled"`
	JSON    applicationGetResponseCcDurableObjectApplicationObservabilityLogsJSON `json:"-"`
}

Application-wide logging settings.

func (*ApplicationGetResponseCcDurableObjectApplicationObservabilityLogs) UnmarshalJSON

type ApplicationGetResponseCcDurableObjectApplicationSchedulingPolicy

type ApplicationGetResponseCcDurableObjectApplicationSchedulingPolicy string

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

const (
	ApplicationGetResponseCcDurableObjectApplicationSchedulingPolicyDurableObject ApplicationGetResponseCcDurableObjectApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationGetResponseCcDurableObjectApplicationSchedulingPolicy) IsKnown

type ApplicationGetResponseCcScheduledApplication

type ApplicationGetResponseCcScheduledApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// User-specified container configuration.
	Configuration ApplicationGetResponseCcScheduledApplicationConfiguration `json:"configuration" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Number of deployments to create.
	Instances int64 `json:"instances" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationGetResponseCcScheduledApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	Version   int64  `json:"version" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string                                                  `json:"active_rollout_id"`
	Constraints     ApplicationGetResponseCcScheduledApplicationConstraints `json:"constraints"`
	// Durable object configuration stored on and returned from a Cloudchamber
	// application.
	DurableObjects ApplicationGetResponseCcScheduledApplicationDurableObjects `json:"durable_objects"`
	Health         ApplicationGetResponseCcScheduledApplicationHealth         `json:"health"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// Top-level observability settings for the application. This field is mutually
	// exclusive with configuration.observability.
	Observability ApplicationGetResponseCcScheduledApplicationObservability `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                                            `json:"rollout_active_grace_period"`
	JSON                     applicationGetResponseCcScheduledApplicationJSON `json:"-"`
}

Describes an application and the parameters that govern how it places its instances.

func (*ApplicationGetResponseCcScheduledApplication) UnmarshalJSON

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

type ApplicationGetResponseCcScheduledApplicationConfiguration

type ApplicationGetResponseCcScheduledApplicationConfiguration struct {
	// Image url.
	Image          string                                                                   `json:"image" api:"required"`
	AuthorizedKeys []ApplicationGetResponseCcScheduledApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command []string `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint []string `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables []ApplicationGetResponseCcScheduledApplicationConfigurationEnvironmentVariable `json:"environment_variables"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability ApplicationGetResponseCcScheduledApplicationConfigurationObservability `json:"observability"`
	JSON          applicationGetResponseCcScheduledApplicationConfigurationJSON          `json:"-"`
}

User-specified container configuration.

func (*ApplicationGetResponseCcScheduledApplicationConfiguration) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationConfigurationAuthorizedKey

type ApplicationGetResponseCcScheduledApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                     `json:"name"`
	JSON applicationGetResponseCcScheduledApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationGetResponseCcScheduledApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationConfigurationEnvironmentVariable

type ApplicationGetResponseCcScheduledApplicationConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name string `json:"name" api:"required"`
	// An environment variable value.
	Value string                                                                           `json:"value" api:"required"`
	JSON  applicationGetResponseCcScheduledApplicationConfigurationEnvironmentVariableJSON `json:"-"`
}

An environment variable with a value set.

func (*ApplicationGetResponseCcScheduledApplicationConfigurationEnvironmentVariable) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType

type ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationGetResponseCcScheduledApplicationConfigurationInstanceTypeLite      ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType = "lite"
	ApplicationGetResponseCcScheduledApplicationConfigurationInstanceTypeBasic     ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType = "basic"
	ApplicationGetResponseCcScheduledApplicationConfigurationInstanceTypeStandard1 ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType = "standard-1"
	ApplicationGetResponseCcScheduledApplicationConfigurationInstanceTypeStandard2 ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType = "standard-2"
	ApplicationGetResponseCcScheduledApplicationConfigurationInstanceTypeStandard3 ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType = "standard-3"
	ApplicationGetResponseCcScheduledApplicationConfigurationInstanceTypeStandard4 ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType = "standard-4"
)

func (ApplicationGetResponseCcScheduledApplicationConfigurationInstanceType) IsKnown

type ApplicationGetResponseCcScheduledApplicationConfigurationObservability

type ApplicationGetResponseCcScheduledApplicationConfigurationObservability struct {
	// Observability logging settings.
	Logs ApplicationGetResponseCcScheduledApplicationConfigurationObservabilityLogs `json:"logs"`
	JSON applicationGetResponseCcScheduledApplicationConfigurationObservabilityJSON `json:"-"`
}

Settings for deployment observability such as logging.

func (*ApplicationGetResponseCcScheduledApplicationConfigurationObservability) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationConfigurationObservabilityLogs

type ApplicationGetResponseCcScheduledApplicationConfigurationObservabilityLogs struct {
	Enabled bool                                                                           `json:"enabled"`
	JSON    applicationGetResponseCcScheduledApplicationConfigurationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationGetResponseCcScheduledApplicationConfigurationObservabilityLogs) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationConstraints

type ApplicationGetResponseCcScheduledApplicationConstraints struct {
	// Restricts placement to datacenters in the selected jurisdiction. Choose "eu",
	// "fedramp", or "us". When combined with regions, EU supports EEUR and WEUR while
	// FedRAMP and US support ENAM and WNAM.
	Jurisdiction string                                                      `json:"jurisdiction"`
	Regions      []string                                                    `json:"regions"`
	JSON         applicationGetResponseCcScheduledApplicationConstraintsJSON `json:"-"`
}

func (*ApplicationGetResponseCcScheduledApplicationConstraints) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationDurableObjects

type ApplicationGetResponseCcScheduledApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                         `json:"namespace_id" api:"required"`
	JSON        applicationGetResponseCcScheduledApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration stored on and returned from a Cloudchamber application.

func (*ApplicationGetResponseCcScheduledApplicationDurableObjects) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationHealth

type ApplicationGetResponseCcScheduledApplicationHealth struct {
	Errors []ApplicationGetResponseCcScheduledApplicationHealthError `json:"errors" api:"required"`
	// Shows a count of application instance states.
	Instances ApplicationGetResponseCcScheduledApplicationHealthInstances `json:"instances" api:"required"`
	// High-level health assessment. Only populated for "new_instances" strategy. Based
	// on a sample of target-version instances rather than a full count.
	//
	// - "pending": Zero target-version instances exist yet.
	// - "healthy": Every sampled target-version instance reports running or active.
	// - "degraded": Some sampled instances remain starting or scheduling.
	// - "unhealthy": One or more sampled instances have failed.
	Summary ApplicationGetResponseCcScheduledApplicationHealthSummary `json:"summary"`
	JSON    applicationGetResponseCcScheduledApplicationHealthJSON    `json:"-"`
}

func (*ApplicationGetResponseCcScheduledApplicationHealth) UnmarshalJSON

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

type ApplicationGetResponseCcScheduledApplicationHealthError

type ApplicationGetResponseCcScheduledApplicationHealthError struct {
	// An event within a Placement or a Job.
	Event ApplicationGetResponseCcScheduledApplicationHealthErrorsEvent `json:"event" api:"required"`
	// An instance ID represents an identifier of an instance configuration that
	// maintains an underlying placement.
	InstanceID string                                                      `json:"instance_id" api:"required"`
	JSON       applicationGetResponseCcScheduledApplicationHealthErrorJSON `json:"-"`
}

func (*ApplicationGetResponseCcScheduledApplicationHealthError) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationHealthErrorsEvent

type ApplicationGetResponseCcScheduledApplicationHealthErrorsEvent struct {
	ID      string                 `json:"id" api:"required"`
	Details map[string]interface{} `json:"details" api:"required"`
	Message string                 `json:"message" api:"required"`
	// Name of the event that describes the kind event that happened.
	//
	//   - SchedulerPlaced: It's the first event that creates a container placement. It
	//     happens when the Containers runtime was able to retrieve deployment resources
	//     and start verifying everything is correct.
	//   - NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the
	//     container.
	//   - VMStarted: It's sent when the Containers runtime starts the VM. The container
	//     might remain unhealthy at this point.
	//   - ImagePulled: It's sent when the Containers runtime pulls the image
	//     successfully.
	//   - ImagePullError: It's sent when the Containers runtime is having issues pulling
	//     the image. The message and details have more information on what happened for
	//     debugging.
	//   - VMFailedToStart: It's sent when the Containers runtime was unable to boot the
	//     VM.
	//   - VMStopping: It's sent when the scheduler is stopping the VM.
	//   - VMStopped: It's sent when the VM finally exits.
	//   - VMFailed: It's sent when the scheduling of the VM failed in the current
	//     location.
	//   - RuntimeStartFailed: It's sent when the runtime hits an internal error.
	//   - SSHStarted: It's sent when the container gains network connectivity and opens
	//     the SSH port. Containers only send this event when SSH keys exist.
	//   - CheckUpdate: Sent when the status of a health or readiness check changes. This
	//     may also affect the health status of the placement.
	//   - DurableObjectConnected: Sent when a durable object instance connects and gains
	//     control of the deployment. This event is only sent for durable object
	//     deployments. It is sent after VMStarted.
	//   - ContainerStarted: It's sent when the container starts running.
	Name         ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName `json:"name" api:"required"`
	StatusChange map[string]interface{}                                            `json:"statusChange" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	Time string                                                            `json:"time" api:"required"`
	Type ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType `json:"type" api:"required"`
	JSON applicationGetResponseCcScheduledApplicationHealthErrorsEventJSON `json:"-"`
}

An event within a Placement or a Job.

func (*ApplicationGetResponseCcScheduledApplicationHealthErrorsEvent) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName

type ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName string

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It's the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the container.
  • VMStarted: It's sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It's sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It's sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It's sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It's sent when the scheduler is stopping the VM.
  • VMStopped: It's sent when the VM finally exits.
  • VMFailed: It's sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It's sent when the runtime hits an internal error.
  • SSHStarted: It's sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It's sent when the container starts running.
const (
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameSchedulerPlaced              ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "SchedulerPlaced"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssigned         ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssigned"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameVmStarted                    ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "VMStarted"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameImagePulled                  ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "ImagePulled"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameImagePullError               ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "ImagePullError"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameVmFailedToStart              ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "VMFailedToStart"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssignmentFailed ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssignmentFailed"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameVmRunning                    ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "VMRunning"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameVmStopping                   ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "VMStopping"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameVmStopped                    ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "VMStopped"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameVmFailed                     ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "VMFailed"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameRuntimeStartFailed           ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "RuntimeStartFailed"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameSSHStarted                   ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "SSHStarted"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameServiceHealthUpdates         ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "ServiceHealthUpdates"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameCheckUpdate                  ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "CheckUpdate"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameDurableObjectConnected       ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "DurableObjectConnected"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventNameContainerStarted             ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName = "ContainerStarted"
)

func (ApplicationGetResponseCcScheduledApplicationHealthErrorsEventName) IsKnown

type ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType

type ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType string
const (
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventTypeInfo        ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType = "Info"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventTypeError       ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType = "Error"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventTypeWarn        ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType = "Warn"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventTypeUserError   ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType = "UserError"
	ApplicationGetResponseCcScheduledApplicationHealthErrorsEventTypeSystemError ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType = "SystemError"
)

func (ApplicationGetResponseCcScheduledApplicationHealthErrorsEventType) IsKnown

type ApplicationGetResponseCcScheduledApplicationHealthInstances

type ApplicationGetResponseCcScheduledApplicationHealthInstances struct {
	// Number of instances whose runtime reports the container as running
	// (container_status = "running"). This is a subset of the placements that remain
	// up: an instance that is already bound to a Durable Object and serving traffic is
	// counted under "assigned" until its container_status catches up to "running", so
	// container_status can briefly lag Durable Object attachment under churn. To
	// estimate running, Durable-Object-bound instances, sum "active" + "assigned"
	// rather than reading "active" alone.
	Active int64 `json:"active" api:"required"`
	// Number of instances bound to a Durable Object with a running placement whose
	// container_status remains behind "running". These count as live, serving
	// instances; "active" + "assigned" approximates the running, Durable-Object-bound
	// count.
	Assigned int64                                                           `json:"assigned" api:"required"`
	JSON     applicationGetResponseCcScheduledApplicationHealthInstancesJSON `json:"-"`
}

Shows a count of application instance states.

func (*ApplicationGetResponseCcScheduledApplicationHealthInstances) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationHealthSummary

type ApplicationGetResponseCcScheduledApplicationHealthSummary string

High-level health assessment. Only populated for "new_instances" strategy. Based on a sample of target-version instances rather than a full count.

- "pending": Zero target-version instances exist yet. - "healthy": Every sampled target-version instance reports running or active. - "degraded": Some sampled instances remain starting or scheduling. - "unhealthy": One or more sampled instances have failed.

const (
	ApplicationGetResponseCcScheduledApplicationHealthSummaryHealthy   ApplicationGetResponseCcScheduledApplicationHealthSummary = "healthy"
	ApplicationGetResponseCcScheduledApplicationHealthSummaryDegraded  ApplicationGetResponseCcScheduledApplicationHealthSummary = "degraded"
	ApplicationGetResponseCcScheduledApplicationHealthSummaryUnhealthy ApplicationGetResponseCcScheduledApplicationHealthSummary = "unhealthy"
	ApplicationGetResponseCcScheduledApplicationHealthSummaryPending   ApplicationGetResponseCcScheduledApplicationHealthSummary = "pending"
)

func (ApplicationGetResponseCcScheduledApplicationHealthSummary) IsKnown

type ApplicationGetResponseCcScheduledApplicationObservability

type ApplicationGetResponseCcScheduledApplicationObservability struct {
	// Observability logging settings.
	Logs ApplicationGetResponseCcScheduledApplicationObservabilityLogs `json:"logs"`
	JSON applicationGetResponseCcScheduledApplicationObservabilityJSON `json:"-"`
}

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

func (*ApplicationGetResponseCcScheduledApplicationObservability) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationObservabilityLogs

type ApplicationGetResponseCcScheduledApplicationObservabilityLogs struct {
	Enabled bool                                                              `json:"enabled"`
	JSON    applicationGetResponseCcScheduledApplicationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationGetResponseCcScheduledApplicationObservabilityLogs) UnmarshalJSON

type ApplicationGetResponseCcScheduledApplicationSchedulingPolicy

type ApplicationGetResponseCcScheduledApplicationSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationGetResponseCcScheduledApplicationSchedulingPolicyDefault       ApplicationGetResponseCcScheduledApplicationSchedulingPolicy = "default"
	ApplicationGetResponseCcScheduledApplicationSchedulingPolicyDurableObject ApplicationGetResponseCcScheduledApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationGetResponseCcScheduledApplicationSchedulingPolicy) IsKnown

type ApplicationGetResponseEnvelope

type ApplicationGetResponseEnvelope struct {
	Errors   []ApplicationGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ApplicationGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// The public Containers API returns an application.
	Result ApplicationGetResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                               `json:"success" api:"required"`
	JSON    applicationGetResponseEnvelopeJSON `json:"-"`
}

func (*ApplicationGetResponseEnvelope) UnmarshalJSON

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

type ApplicationGetResponseEnvelopeErrors

type ApplicationGetResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ApplicationGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             applicationGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ApplicationGetResponseEnvelopeErrors) UnmarshalJSON

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

type ApplicationGetResponseEnvelopeErrorsSource

type ApplicationGetResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    applicationGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ApplicationGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ApplicationGetResponseEnvelopeMessages

type ApplicationGetResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ApplicationGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             applicationGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ApplicationGetResponseEnvelopeMessages) UnmarshalJSON

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

type ApplicationGetResponseEnvelopeMessagesSource

type ApplicationGetResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    applicationGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ApplicationGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ApplicationGetResponseSchedulingPolicy

type ApplicationGetResponseSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationGetResponseSchedulingPolicyDefault       ApplicationGetResponseSchedulingPolicy = "default"
	ApplicationGetResponseSchedulingPolicyDurableObject ApplicationGetResponseSchedulingPolicy = "durable_object"
)

func (ApplicationGetResponseSchedulingPolicy) IsKnown

type ApplicationGetResponseUnion

type ApplicationGetResponseUnion interface {
	// contains filtered or unexported methods
}

The public Containers API returns an application.

Union satisfied by ApplicationGetResponseCcScheduledApplication or ApplicationGetResponseCcDurableObjectApplication.

type ApplicationInstanceGetParams

type ApplicationInstanceGetParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ApplicationInstanceGetResponse

type ApplicationInstanceGetResponse struct {
	// A container instance ID (64-character hex Durable Object actor ID).
	ID string `json:"id" api:"required"`
	// An Application ID represents an identifier of an application.
	ApplicationID string `json:"application_id" api:"required"`
	// The image for the current container placement, when one is available.
	Image string `json:"image" api:"required"`
	// The latest known status of a container instance.
	Status ApplicationInstanceGetResponseStatus `json:"status" api:"required"`
	// The resources allocated to the container instance.
	Configuration ApplicationInstanceGetResponseConfiguration `json:"configuration"`
	// The location of the instance's current container placement.
	Location ApplicationInstanceGetResponseLocation `json:"location"`
	// The customer-provided instance name, when available. Its UTF-8 encoding uses at
	// most 1,024 bytes.
	Name string `json:"name"`
	// The time at which the current container placement started, when one exists.
	StartedAt string                             `json:"started_at"`
	JSON      applicationInstanceGetResponseJSON `json:"-"`
}

The last-reported state of a logical container instance.

func (*ApplicationInstanceGetResponse) UnmarshalJSON

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

type ApplicationInstanceGetResponseConfiguration

type ApplicationInstanceGetResponseConfiguration struct {
	// Disk allocated to the container instance, in decimal MB.
	Disk int64 `json:"disk" api:"required"`
	// Memory allocated to the container instance, in MiB.
	Memory int64 `json:"memory" api:"required"`
	// Number of virtual CPUs allocated to the container instance.
	Vcpu float64                                         `json:"vcpu" api:"required"`
	JSON applicationInstanceGetResponseConfigurationJSON `json:"-"`
}

The resources allocated to the container instance.

func (*ApplicationInstanceGetResponseConfiguration) UnmarshalJSON

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

type ApplicationInstanceGetResponseEnvelope

type ApplicationInstanceGetResponseEnvelope struct {
	Errors   []ApplicationInstanceGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ApplicationInstanceGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// The last-reported state of a logical container instance.
	Result ApplicationInstanceGetResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                                       `json:"success" api:"required"`
	JSON    applicationInstanceGetResponseEnvelopeJSON `json:"-"`
}

func (*ApplicationInstanceGetResponseEnvelope) UnmarshalJSON

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

type ApplicationInstanceGetResponseEnvelopeErrors

type ApplicationInstanceGetResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code" api:"required"`
	Message          string                                             `json:"message" api:"required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ApplicationInstanceGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             applicationInstanceGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ApplicationInstanceGetResponseEnvelopeErrors) UnmarshalJSON

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

type ApplicationInstanceGetResponseEnvelopeErrorsSource

type ApplicationInstanceGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    applicationInstanceGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ApplicationInstanceGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ApplicationInstanceGetResponseEnvelopeMessages

type ApplicationInstanceGetResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           ApplicationInstanceGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             applicationInstanceGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ApplicationInstanceGetResponseEnvelopeMessages) UnmarshalJSON

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

type ApplicationInstanceGetResponseEnvelopeMessagesSource

type ApplicationInstanceGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    applicationInstanceGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ApplicationInstanceGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ApplicationInstanceGetResponseLocation

type ApplicationInstanceGetResponseLocation struct {
	// Unique location code used to identify locations on a logical level.
	Name string `json:"name" api:"required"`
	// Represents a group of datacenters. Choose one of "AFR", "APAC", "EEUR", "ENAM",
	// "WNAM", "ME", "OC", "SAM", or "WEUR".
	Region string                                     `json:"region" api:"required"`
	JSON   applicationInstanceGetResponseLocationJSON `json:"-"`
}

The location of the instance's current container placement.

func (*ApplicationInstanceGetResponseLocation) UnmarshalJSON

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

type ApplicationInstanceGetResponseStatus

type ApplicationInstanceGetResponseStatus struct {
	// The current lifecycle state of a container instance.
	State ApplicationInstanceGetResponseStatusState `json:"state" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// The process exit code, when the runtime reports one.
	ExitCode int64                                    `json:"exit_code"`
	JSON     applicationInstanceGetResponseStatusJSON `json:"-"`
}

The latest known status of a container instance.

func (*ApplicationInstanceGetResponseStatus) UnmarshalJSON

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

type ApplicationInstanceGetResponseStatusState

type ApplicationInstanceGetResponseStatusState string

The current lifecycle state of a container instance.

const (
	ApplicationInstanceGetResponseStatusStateProvisioning ApplicationInstanceGetResponseStatusState = "provisioning"
	ApplicationInstanceGetResponseStatusStateRunning      ApplicationInstanceGetResponseStatusState = "running"
	ApplicationInstanceGetResponseStatusStateFailed       ApplicationInstanceGetResponseStatusState = "failed"
	ApplicationInstanceGetResponseStatusStateStopping     ApplicationInstanceGetResponseStatusState = "stopping"
	ApplicationInstanceGetResponseStatusStateStopped      ApplicationInstanceGetResponseStatusState = "stopped"
	ApplicationInstanceGetResponseStatusStateUnhealthy    ApplicationInstanceGetResponseStatusState = "unhealthy"
	ApplicationInstanceGetResponseStatusStateInactive     ApplicationInstanceGetResponseStatusState = "inactive"
	ApplicationInstanceGetResponseStatusStateUnknown      ApplicationInstanceGetResponseStatusState = "unknown"
)

func (ApplicationInstanceGetResponseStatusState) IsKnown

type ApplicationInstanceListParams

type ApplicationInstanceListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Filter instances by a case-sensitive name prefix, falling back to the actor ID
	// when no name is known. Keep the same prefix when using a page token.
	NamePrefix param.Field[string] `query:"name_prefix"`
	// Opaque token from a previous response to retrieve the next page.
	PageToken param.Field[string] `query:"page_token"`
	// Maximum number of instances to return per page. Defaults to 100.
	PerPage param.Field[int64] `query:"per_page"`
	// Filters instances by lifecycle state. `active` includes provisioning, running,
	// and stopping instances; `not-active` includes stopped and failed instances. When
	// omitted, all instances are returned.
	State param.Field[ApplicationInstanceListParamsState] `query:"state"`
}

func (ApplicationInstanceListParams) URLQuery

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

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

type ApplicationInstanceListParamsState

type ApplicationInstanceListParamsState string

Filters instances by lifecycle state. `active` includes provisioning, running, and stopping instances; `not-active` includes stopped and failed instances. When omitted, all instances are returned.

const (
	ApplicationInstanceListParamsStateActive    ApplicationInstanceListParamsState = "active"
	ApplicationInstanceListParamsStateNotActive ApplicationInstanceListParamsState = "not-active"
)

func (ApplicationInstanceListParamsState) IsKnown

type ApplicationInstanceListResponse

type ApplicationInstanceListResponse struct {
	// A container instance ID (64-character hex Durable Object actor ID).
	ID string `json:"id" api:"required"`
	// An Application ID represents an identifier of an application.
	ApplicationID string `json:"application_id" api:"required"`
	// The image for the current container placement, when one is available.
	Image string `json:"image" api:"required"`
	// The latest known status of a container instance.
	Status ApplicationInstanceListResponseStatus `json:"status" api:"required"`
	// The resources allocated to the container instance.
	Configuration ApplicationInstanceListResponseConfiguration `json:"configuration"`
	// The location of the instance's current container placement.
	Location ApplicationInstanceListResponseLocation `json:"location"`
	// The customer-provided instance name, when available. Its UTF-8 encoding uses at
	// most 1,024 bytes.
	Name string `json:"name"`
	// The time at which the current container placement started, when one exists.
	StartedAt string                              `json:"started_at"`
	JSON      applicationInstanceListResponseJSON `json:"-"`
}

The last-reported state of a logical container instance.

func (*ApplicationInstanceListResponse) UnmarshalJSON

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

type ApplicationInstanceListResponseConfiguration

type ApplicationInstanceListResponseConfiguration struct {
	// Disk allocated to the container instance, in decimal MB.
	Disk int64 `json:"disk" api:"required"`
	// Memory allocated to the container instance, in MiB.
	Memory int64 `json:"memory" api:"required"`
	// Number of virtual CPUs allocated to the container instance.
	Vcpu float64                                          `json:"vcpu" api:"required"`
	JSON applicationInstanceListResponseConfigurationJSON `json:"-"`
}

The resources allocated to the container instance.

func (*ApplicationInstanceListResponseConfiguration) UnmarshalJSON

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

type ApplicationInstanceListResponseLocation

type ApplicationInstanceListResponseLocation struct {
	// Unique location code used to identify locations on a logical level.
	Name string `json:"name" api:"required"`
	// Represents a group of datacenters. Choose one of "AFR", "APAC", "EEUR", "ENAM",
	// "WNAM", "ME", "OC", "SAM", or "WEUR".
	Region string                                      `json:"region" api:"required"`
	JSON   applicationInstanceListResponseLocationJSON `json:"-"`
}

The location of the instance's current container placement.

func (*ApplicationInstanceListResponseLocation) UnmarshalJSON

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

type ApplicationInstanceListResponseStatus

type ApplicationInstanceListResponseStatus struct {
	// The current lifecycle state of a container instance.
	State ApplicationInstanceListResponseStatusState `json:"state" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// The process exit code, when the runtime reports one.
	ExitCode int64                                     `json:"exit_code"`
	JSON     applicationInstanceListResponseStatusJSON `json:"-"`
}

The latest known status of a container instance.

func (*ApplicationInstanceListResponseStatus) UnmarshalJSON

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

type ApplicationInstanceListResponseStatusState

type ApplicationInstanceListResponseStatusState string

The current lifecycle state of a container instance.

const (
	ApplicationInstanceListResponseStatusStateProvisioning ApplicationInstanceListResponseStatusState = "provisioning"
	ApplicationInstanceListResponseStatusStateRunning      ApplicationInstanceListResponseStatusState = "running"
	ApplicationInstanceListResponseStatusStateFailed       ApplicationInstanceListResponseStatusState = "failed"
	ApplicationInstanceListResponseStatusStateStopping     ApplicationInstanceListResponseStatusState = "stopping"
	ApplicationInstanceListResponseStatusStateStopped      ApplicationInstanceListResponseStatusState = "stopped"
	ApplicationInstanceListResponseStatusStateUnhealthy    ApplicationInstanceListResponseStatusState = "unhealthy"
	ApplicationInstanceListResponseStatusStateInactive     ApplicationInstanceListResponseStatusState = "inactive"
	ApplicationInstanceListResponseStatusStateUnknown      ApplicationInstanceListResponseStatusState = "unknown"
)

func (ApplicationInstanceListResponseStatusState) IsKnown

type ApplicationInstanceListV1Params

type ApplicationInstanceListV1Params struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Filter instances by a case-sensitive name prefix, falling back to the actor ID
	// when no name is known. Keep the same prefix when using a page token.
	NamePrefix param.Field[string] `query:"name_prefix"`
	// Opaque token from a previous response to retrieve the next page.
	PageToken param.Field[string] `query:"page_token"`
	// Maximum number of instances to return per page. Defaults to all.
	PerPage param.Field[int64] `query:"per_page"`
	// Filters instances by lifecycle state. `active` includes provisioning, running,
	// and stopping instances; `not-active` includes stopped and failed instances. When
	// omitted, all instances are returned.
	State param.Field[ApplicationInstanceListV1ParamsState] `query:"state"`
}

func (ApplicationInstanceListV1Params) URLQuery

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

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

type ApplicationInstanceListV1ParamsState

type ApplicationInstanceListV1ParamsState string

Filters instances by lifecycle state. `active` includes provisioning, running, and stopping instances; `not-active` includes stopped and failed instances. When omitted, all instances are returned.

const (
	ApplicationInstanceListV1ParamsStateActive    ApplicationInstanceListV1ParamsState = "active"
	ApplicationInstanceListV1ParamsStateNotActive ApplicationInstanceListV1ParamsState = "not-active"
)

func (ApplicationInstanceListV1ParamsState) IsKnown

type ApplicationInstanceListV1Response

type ApplicationInstanceListV1Response struct {
	// A container instance ID (64-character hex Durable Object actor ID).
	ID string `json:"id" api:"required"`
	// An Application ID represents an identifier of an application.
	ApplicationID string `json:"application_id" api:"required"`
	// The image for the current container placement, when one is available.
	Image string `json:"image" api:"required"`
	// The latest known status of a container instance.
	Status ApplicationInstanceListV1ResponseStatus `json:"status" api:"required"`
	// The resources allocated to the container instance.
	Configuration ApplicationInstanceListV1ResponseConfiguration `json:"configuration"`
	// The location of the instance's current container placement.
	Location ApplicationInstanceListV1ResponseLocation `json:"location"`
	// The customer-provided instance name, when available. Its UTF-8 encoding uses at
	// most 1,024 bytes.
	Name string `json:"name"`
	// The time at which the current container placement started, when one exists.
	StartedAt string                                `json:"started_at"`
	JSON      applicationInstanceListV1ResponseJSON `json:"-"`
}

The last-reported state of a logical container instance.

func (*ApplicationInstanceListV1Response) UnmarshalJSON

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

type ApplicationInstanceListV1ResponseConfiguration

type ApplicationInstanceListV1ResponseConfiguration struct {
	// Disk allocated to the container instance, in decimal MB.
	Disk int64 `json:"disk" api:"required"`
	// Memory allocated to the container instance, in MiB.
	Memory int64 `json:"memory" api:"required"`
	// Number of virtual CPUs allocated to the container instance.
	Vcpu float64                                            `json:"vcpu" api:"required"`
	JSON applicationInstanceListV1ResponseConfigurationJSON `json:"-"`
}

The resources allocated to the container instance.

func (*ApplicationInstanceListV1ResponseConfiguration) UnmarshalJSON

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

type ApplicationInstanceListV1ResponseLocation

type ApplicationInstanceListV1ResponseLocation struct {
	// Unique location code used to identify locations on a logical level.
	Name string `json:"name" api:"required"`
	// Represents a group of datacenters. Choose one of "AFR", "APAC", "EEUR", "ENAM",
	// "WNAM", "ME", "OC", "SAM", or "WEUR".
	Region string                                        `json:"region" api:"required"`
	JSON   applicationInstanceListV1ResponseLocationJSON `json:"-"`
}

The location of the instance's current container placement.

func (*ApplicationInstanceListV1ResponseLocation) UnmarshalJSON

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

type ApplicationInstanceListV1ResponseStatus

type ApplicationInstanceListV1ResponseStatus struct {
	// The current lifecycle state of a container instance.
	State ApplicationInstanceListV1ResponseStatusState `json:"state" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// The process exit code, when the runtime reports one.
	ExitCode int64                                       `json:"exit_code"`
	JSON     applicationInstanceListV1ResponseStatusJSON `json:"-"`
}

The latest known status of a container instance.

func (*ApplicationInstanceListV1ResponseStatus) UnmarshalJSON

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

type ApplicationInstanceListV1ResponseStatusState

type ApplicationInstanceListV1ResponseStatusState string

The current lifecycle state of a container instance.

const (
	ApplicationInstanceListV1ResponseStatusStateProvisioning ApplicationInstanceListV1ResponseStatusState = "provisioning"
	ApplicationInstanceListV1ResponseStatusStateRunning      ApplicationInstanceListV1ResponseStatusState = "running"
	ApplicationInstanceListV1ResponseStatusStateFailed       ApplicationInstanceListV1ResponseStatusState = "failed"
	ApplicationInstanceListV1ResponseStatusStateStopping     ApplicationInstanceListV1ResponseStatusState = "stopping"
	ApplicationInstanceListV1ResponseStatusStateStopped      ApplicationInstanceListV1ResponseStatusState = "stopped"
	ApplicationInstanceListV1ResponseStatusStateUnhealthy    ApplicationInstanceListV1ResponseStatusState = "unhealthy"
	ApplicationInstanceListV1ResponseStatusStateInactive     ApplicationInstanceListV1ResponseStatusState = "inactive"
	ApplicationInstanceListV1ResponseStatusStateUnknown      ApplicationInstanceListV1ResponseStatusState = "unknown"
)

func (ApplicationInstanceListV1ResponseStatusState) IsKnown

type ApplicationInstanceService

type ApplicationInstanceService struct {
	Options []option.RequestOption
}

ApplicationInstanceService 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 NewApplicationInstanceService method instead.

func NewApplicationInstanceService

func NewApplicationInstanceService(opts ...option.RequestOption) (r *ApplicationInstanceService)

NewApplicationInstanceService 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 (*ApplicationInstanceService) Get

Returns a container instance belonging to an application.

func (*ApplicationInstanceService) List

Lists container instances belonging to an application.

func (*ApplicationInstanceService) ListAutoPaging

Lists container instances belonging to an application.

func (*ApplicationInstanceService) ListV1 deprecated

Deprecated: use `instances-v2` instead. Lists container instances belonging to an application.

Deprecated: deprecated

func (*ApplicationInstanceService) ListV1AutoPaging deprecated

Deprecated: use `instances-v2` instead. Lists container instances belonging to an application.

Deprecated: deprecated

type ApplicationListParams

type ApplicationListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Filter applications by image.
	Image param.Field[string] `query:"image"`
	// Filter applications by name.
	Name param.Field[string] `query:"name"`
	// Opaque token from a previous response to retrieve the next page.
	PageToken param.Field[string] `query:"page_token"`
	// Maximum number of applications to return per page. Defaults to all, or 100 when
	// `page_token` is set.
	PerPage param.Field[int64] `query:"per_page"`
}

func (ApplicationListParams) URLQuery

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

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

type ApplicationListResponse

type ApplicationListResponse struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationListResponseSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string `json:"active_rollout_id"`
	// This field can have the runtime type of
	// [ApplicationListResponseCcScheduledApplicationConfiguration],
	// [ApplicationListResponseCcDurableObjectApplicationConfiguration].
	Configuration interface{} `json:"configuration"`
	// This field can have the runtime type of
	// [ApplicationListResponseCcScheduledApplicationConstraints].
	Constraints interface{} `json:"constraints"`
	// This field can have the runtime type of
	// [ApplicationListResponseCcScheduledApplicationDurableObjects],
	// [ApplicationListResponseCcDurableObjectApplicationDurableObjects].
	DurableObjects interface{} `json:"durable_objects"`
	// This field can have the runtime type of
	// [ApplicationListResponseCcScheduledApplicationHealth],
	// [ApplicationListResponseCcDurableObjectApplicationHealth].
	Health interface{} `json:"health"`
	// Number of deployments to create.
	Instances int64 `json:"instances"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// This field can have the runtime type of
	// [ApplicationListResponseCcScheduledApplicationObservability],
	// [ApplicationListResponseCcDurableObjectApplicationObservability].
	Observability interface{} `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                       `json:"rollout_active_grace_period"`
	Version                  int64                       `json:"version"`
	JSON                     applicationListResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

The public Containers API returns an application.

func (ApplicationListResponse) AsUnion

AsUnion returns a ApplicationListResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are ApplicationListResponseCcScheduledApplication, ApplicationListResponseCcDurableObjectApplication.

func (*ApplicationListResponse) UnmarshalJSON

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

type ApplicationListResponseCcDurableObjectApplication

type ApplicationListResponseCcDurableObjectApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Durable object configuration using a namespace ID.
	DurableObjects ApplicationListResponseCcDurableObjectApplicationDurableObjects `json:"durable_objects" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// Selects a Durable Object-managed application. Each Durable Object creates and
	// manages the lifecycle of its container instance. Configure application-wide
	// observability settings here. Deployment configuration, scaling, placement
	// constraints, versions, and rollouts do not apply.
	SchedulingPolicy ApplicationListResponseCcDurableObjectApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// Application-wide settings for a Durable Object-managed application.
	Configuration ApplicationListResponseCcDurableObjectApplicationConfiguration `json:"configuration"`
	// Aggregate current activity for the latest observed placement of each instance.
	// Runtime snapshots feed periodic background sweeps. Counts refresh after each
	// complete sweep. Instance listings retain their separate three-month history for
	// failure discovery.
	Health ApplicationListResponseCcDurableObjectApplicationHealth `json:"health"`
	// Application-wide logging settings for a Durable Object-managed application. The
	// application publishes these settings to its runtime metadata. Updating them does
	// not create a deployment or rollout.
	Observability ApplicationListResponseCcDurableObjectApplicationObservability `json:"observability"`
	JSON          applicationListResponseCcDurableObjectApplicationJSON          `json:"-"`
}

Each Durable Object creates and manages the lifecycle of its container instance.

func (*ApplicationListResponseCcDurableObjectApplication) UnmarshalJSON

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

type ApplicationListResponseCcDurableObjectApplicationConfiguration

type ApplicationListResponseCcDurableObjectApplicationConfiguration struct {
	AuthorizedKeys []ApplicationListResponseCcDurableObjectApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// Configuration properties for connecting with SSH to a container using Wrangler.
	WranglerSSH ApplicationListResponseCcDurableObjectApplicationConfigurationWranglerSSH `json:"wrangler_ssh"`
	JSON        applicationListResponseCcDurableObjectApplicationConfigurationJSON        `json:"-"`
}

Application-wide settings for a Durable Object-managed application.

func (*ApplicationListResponseCcDurableObjectApplicationConfiguration) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationConfigurationAuthorizedKey

type ApplicationListResponseCcDurableObjectApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                          `json:"name"`
	JSON applicationListResponseCcDurableObjectApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationListResponseCcDurableObjectApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationConfigurationWranglerSSH

type ApplicationListResponseCcDurableObjectApplicationConfigurationWranglerSSH struct {
	Enabled bool                                                                          `json:"enabled"`
	Port    int64                                                                         `json:"port"`
	JSON    applicationListResponseCcDurableObjectApplicationConfigurationWranglerSSHJSON `json:"-"`
}

Configuration properties for connecting with SSH to a container using Wrangler.

func (*ApplicationListResponseCcDurableObjectApplicationConfigurationWranglerSSH) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationDurableObjects

type ApplicationListResponseCcDurableObjectApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                              `json:"namespace_id" api:"required"`
	JSON        applicationListResponseCcDurableObjectApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration using a namespace ID.

func (*ApplicationListResponseCcDurableObjectApplicationDurableObjects) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationHealth

type ApplicationListResponseCcDurableObjectApplicationHealth struct {
	// Counts of observed non-terminal instances.
	Instances ApplicationListResponseCcDurableObjectApplicationHealthInstances `json:"instances" api:"required"`
	// Present as pending until the first activity sweep completes; omitted afterward.
	Summary ApplicationListResponseCcDurableObjectApplicationHealthSummary `json:"summary"`
	JSON    applicationListResponseCcDurableObjectApplicationHealthJSON    `json:"-"`
}

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

func (*ApplicationListResponseCcDurableObjectApplicationHealth) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationHealthInstances

type ApplicationListResponseCcDurableObjectApplicationHealthInstances struct {
	// Number of instances whose runtime reports running or stopping.
	Active int64 `json:"active" api:"required"`
	// Number of instances whose runtime reports starting.
	Starting int64                                                                `json:"starting" api:"required"`
	JSON     applicationListResponseCcDurableObjectApplicationHealthInstancesJSON `json:"-"`
}

Counts of observed non-terminal instances.

func (*ApplicationListResponseCcDurableObjectApplicationHealthInstances) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationHealthSummary

type ApplicationListResponseCcDurableObjectApplicationHealthSummary string

Present as pending until the first activity sweep completes; omitted afterward.

const (
	ApplicationListResponseCcDurableObjectApplicationHealthSummaryPending ApplicationListResponseCcDurableObjectApplicationHealthSummary = "pending"
)

func (ApplicationListResponseCcDurableObjectApplicationHealthSummary) IsKnown

type ApplicationListResponseCcDurableObjectApplicationObservability

type ApplicationListResponseCcDurableObjectApplicationObservability struct {
	// Application-wide logging settings.
	Logs ApplicationListResponseCcDurableObjectApplicationObservabilityLogs `json:"logs"`
	JSON applicationListResponseCcDurableObjectApplicationObservabilityJSON `json:"-"`
}

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

func (*ApplicationListResponseCcDurableObjectApplicationObservability) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationObservabilityLogs

type ApplicationListResponseCcDurableObjectApplicationObservabilityLogs struct {
	Enabled bool                                                                   `json:"enabled"`
	JSON    applicationListResponseCcDurableObjectApplicationObservabilityLogsJSON `json:"-"`
}

Application-wide logging settings.

func (*ApplicationListResponseCcDurableObjectApplicationObservabilityLogs) UnmarshalJSON

type ApplicationListResponseCcDurableObjectApplicationSchedulingPolicy

type ApplicationListResponseCcDurableObjectApplicationSchedulingPolicy string

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

const (
	ApplicationListResponseCcDurableObjectApplicationSchedulingPolicyDurableObject ApplicationListResponseCcDurableObjectApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationListResponseCcDurableObjectApplicationSchedulingPolicy) IsKnown

type ApplicationListResponseCcScheduledApplication

type ApplicationListResponseCcScheduledApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// User-specified container configuration.
	Configuration ApplicationListResponseCcScheduledApplicationConfiguration `json:"configuration" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Number of deployments to create.
	Instances int64 `json:"instances" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationListResponseCcScheduledApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	Version   int64  `json:"version" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string                                                   `json:"active_rollout_id"`
	Constraints     ApplicationListResponseCcScheduledApplicationConstraints `json:"constraints"`
	// Durable object configuration stored on and returned from a Cloudchamber
	// application.
	DurableObjects ApplicationListResponseCcScheduledApplicationDurableObjects `json:"durable_objects"`
	Health         ApplicationListResponseCcScheduledApplicationHealth         `json:"health"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// Top-level observability settings for the application. This field is mutually
	// exclusive with configuration.observability.
	Observability ApplicationListResponseCcScheduledApplicationObservability `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                                             `json:"rollout_active_grace_period"`
	JSON                     applicationListResponseCcScheduledApplicationJSON `json:"-"`
}

Describes an application and the parameters that govern how it places its instances.

func (*ApplicationListResponseCcScheduledApplication) UnmarshalJSON

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

type ApplicationListResponseCcScheduledApplicationConfiguration

type ApplicationListResponseCcScheduledApplicationConfiguration struct {
	// Image url.
	Image          string                                                                    `json:"image" api:"required"`
	AuthorizedKeys []ApplicationListResponseCcScheduledApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command []string `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint []string `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables []ApplicationListResponseCcScheduledApplicationConfigurationEnvironmentVariable `json:"environment_variables"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType ApplicationListResponseCcScheduledApplicationConfigurationInstanceType `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability ApplicationListResponseCcScheduledApplicationConfigurationObservability `json:"observability"`
	JSON          applicationListResponseCcScheduledApplicationConfigurationJSON          `json:"-"`
}

User-specified container configuration.

func (*ApplicationListResponseCcScheduledApplicationConfiguration) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationConfigurationAuthorizedKey

type ApplicationListResponseCcScheduledApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                      `json:"name"`
	JSON applicationListResponseCcScheduledApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationListResponseCcScheduledApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationConfigurationEnvironmentVariable

type ApplicationListResponseCcScheduledApplicationConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name string `json:"name" api:"required"`
	// An environment variable value.
	Value string                                                                            `json:"value" api:"required"`
	JSON  applicationListResponseCcScheduledApplicationConfigurationEnvironmentVariableJSON `json:"-"`
}

An environment variable with a value set.

func (*ApplicationListResponseCcScheduledApplicationConfigurationEnvironmentVariable) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationConfigurationInstanceType

type ApplicationListResponseCcScheduledApplicationConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeLite      ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "lite"
	ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeBasic     ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "basic"
	ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard1 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-1"
	ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard2 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-2"
	ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard3 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-3"
	ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard4 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-4"
)

func (ApplicationListResponseCcScheduledApplicationConfigurationInstanceType) IsKnown

type ApplicationListResponseCcScheduledApplicationConfigurationObservability

type ApplicationListResponseCcScheduledApplicationConfigurationObservability struct {
	// Observability logging settings.
	Logs ApplicationListResponseCcScheduledApplicationConfigurationObservabilityLogs `json:"logs"`
	JSON applicationListResponseCcScheduledApplicationConfigurationObservabilityJSON `json:"-"`
}

Settings for deployment observability such as logging.

func (*ApplicationListResponseCcScheduledApplicationConfigurationObservability) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationConfigurationObservabilityLogs

type ApplicationListResponseCcScheduledApplicationConfigurationObservabilityLogs struct {
	Enabled bool                                                                            `json:"enabled"`
	JSON    applicationListResponseCcScheduledApplicationConfigurationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationListResponseCcScheduledApplicationConfigurationObservabilityLogs) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationConstraints

type ApplicationListResponseCcScheduledApplicationConstraints struct {
	// Restricts placement to datacenters in the selected jurisdiction. Choose "eu",
	// "fedramp", or "us". When combined with regions, EU supports EEUR and WEUR while
	// FedRAMP and US support ENAM and WNAM.
	Jurisdiction string                                                       `json:"jurisdiction"`
	Regions      []string                                                     `json:"regions"`
	JSON         applicationListResponseCcScheduledApplicationConstraintsJSON `json:"-"`
}

func (*ApplicationListResponseCcScheduledApplicationConstraints) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationDurableObjects

type ApplicationListResponseCcScheduledApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                          `json:"namespace_id" api:"required"`
	JSON        applicationListResponseCcScheduledApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration stored on and returned from a Cloudchamber application.

func (*ApplicationListResponseCcScheduledApplicationDurableObjects) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationHealth

type ApplicationListResponseCcScheduledApplicationHealth struct {
	Errors []ApplicationListResponseCcScheduledApplicationHealthError `json:"errors" api:"required"`
	// Shows a count of application instance states.
	Instances ApplicationListResponseCcScheduledApplicationHealthInstances `json:"instances" api:"required"`
	// High-level health assessment. Only populated for "new_instances" strategy. Based
	// on a sample of target-version instances rather than a full count.
	//
	// - "pending": Zero target-version instances exist yet.
	// - "healthy": Every sampled target-version instance reports running or active.
	// - "degraded": Some sampled instances remain starting or scheduling.
	// - "unhealthy": One or more sampled instances have failed.
	Summary ApplicationListResponseCcScheduledApplicationHealthSummary `json:"summary"`
	JSON    applicationListResponseCcScheduledApplicationHealthJSON    `json:"-"`
}

func (*ApplicationListResponseCcScheduledApplicationHealth) UnmarshalJSON

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

type ApplicationListResponseCcScheduledApplicationHealthError

type ApplicationListResponseCcScheduledApplicationHealthError struct {
	// An event within a Placement or a Job.
	Event ApplicationListResponseCcScheduledApplicationHealthErrorsEvent `json:"event" api:"required"`
	// An instance ID represents an identifier of an instance configuration that
	// maintains an underlying placement.
	InstanceID string                                                       `json:"instance_id" api:"required"`
	JSON       applicationListResponseCcScheduledApplicationHealthErrorJSON `json:"-"`
}

func (*ApplicationListResponseCcScheduledApplicationHealthError) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationHealthErrorsEvent

type ApplicationListResponseCcScheduledApplicationHealthErrorsEvent struct {
	ID      string                 `json:"id" api:"required"`
	Details map[string]interface{} `json:"details" api:"required"`
	Message string                 `json:"message" api:"required"`
	// Name of the event that describes the kind event that happened.
	//
	//   - SchedulerPlaced: It's the first event that creates a container placement. It
	//     happens when the Containers runtime was able to retrieve deployment resources
	//     and start verifying everything is correct.
	//   - NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the
	//     container.
	//   - VMStarted: It's sent when the Containers runtime starts the VM. The container
	//     might remain unhealthy at this point.
	//   - ImagePulled: It's sent when the Containers runtime pulls the image
	//     successfully.
	//   - ImagePullError: It's sent when the Containers runtime is having issues pulling
	//     the image. The message and details have more information on what happened for
	//     debugging.
	//   - VMFailedToStart: It's sent when the Containers runtime was unable to boot the
	//     VM.
	//   - VMStopping: It's sent when the scheduler is stopping the VM.
	//   - VMStopped: It's sent when the VM finally exits.
	//   - VMFailed: It's sent when the scheduling of the VM failed in the current
	//     location.
	//   - RuntimeStartFailed: It's sent when the runtime hits an internal error.
	//   - SSHStarted: It's sent when the container gains network connectivity and opens
	//     the SSH port. Containers only send this event when SSH keys exist.
	//   - CheckUpdate: Sent when the status of a health or readiness check changes. This
	//     may also affect the health status of the placement.
	//   - DurableObjectConnected: Sent when a durable object instance connects and gains
	//     control of the deployment. This event is only sent for durable object
	//     deployments. It is sent after VMStarted.
	//   - ContainerStarted: It's sent when the container starts running.
	Name         ApplicationListResponseCcScheduledApplicationHealthErrorsEventName `json:"name" api:"required"`
	StatusChange map[string]interface{}                                             `json:"statusChange" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	Time string                                                             `json:"time" api:"required"`
	Type ApplicationListResponseCcScheduledApplicationHealthErrorsEventType `json:"type" api:"required"`
	JSON applicationListResponseCcScheduledApplicationHealthErrorsEventJSON `json:"-"`
}

An event within a Placement or a Job.

func (*ApplicationListResponseCcScheduledApplicationHealthErrorsEvent) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationHealthErrorsEventName

type ApplicationListResponseCcScheduledApplicationHealthErrorsEventName string

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It's the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the container.
  • VMStarted: It's sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It's sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It's sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It's sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It's sent when the scheduler is stopping the VM.
  • VMStopped: It's sent when the VM finally exits.
  • VMFailed: It's sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It's sent when the runtime hits an internal error.
  • SSHStarted: It's sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It's sent when the container starts running.
const (
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameSchedulerPlaced              ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "SchedulerPlaced"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssigned         ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssigned"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmStarted                    ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMStarted"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameImagePulled                  ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ImagePulled"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameImagePullError               ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ImagePullError"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmFailedToStart              ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMFailedToStart"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssignmentFailed ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssignmentFailed"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmRunning                    ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMRunning"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmStopping                   ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMStopping"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmStopped                    ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMStopped"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmFailed                     ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMFailed"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameRuntimeStartFailed           ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "RuntimeStartFailed"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameSSHStarted                   ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "SSHStarted"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameServiceHealthUpdates         ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ServiceHealthUpdates"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameCheckUpdate                  ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "CheckUpdate"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameDurableObjectConnected       ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "DurableObjectConnected"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameContainerStarted             ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ContainerStarted"
)

func (ApplicationListResponseCcScheduledApplicationHealthErrorsEventName) IsKnown

type ApplicationListResponseCcScheduledApplicationHealthErrorsEventType

type ApplicationListResponseCcScheduledApplicationHealthErrorsEventType string
const (
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeInfo        ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "Info"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeError       ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "Error"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeWarn        ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "Warn"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeUserError   ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "UserError"
	ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeSystemError ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "SystemError"
)

func (ApplicationListResponseCcScheduledApplicationHealthErrorsEventType) IsKnown

type ApplicationListResponseCcScheduledApplicationHealthInstances

type ApplicationListResponseCcScheduledApplicationHealthInstances struct {
	// Number of instances whose runtime reports the container as running
	// (container_status = "running"). This is a subset of the placements that remain
	// up: an instance that is already bound to a Durable Object and serving traffic is
	// counted under "assigned" until its container_status catches up to "running", so
	// container_status can briefly lag Durable Object attachment under churn. To
	// estimate running, Durable-Object-bound instances, sum "active" + "assigned"
	// rather than reading "active" alone.
	Active int64 `json:"active" api:"required"`
	// Number of instances bound to a Durable Object with a running placement whose
	// container_status remains behind "running". These count as live, serving
	// instances; "active" + "assigned" approximates the running, Durable-Object-bound
	// count.
	Assigned int64                                                            `json:"assigned" api:"required"`
	JSON     applicationListResponseCcScheduledApplicationHealthInstancesJSON `json:"-"`
}

Shows a count of application instance states.

func (*ApplicationListResponseCcScheduledApplicationHealthInstances) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationHealthSummary

type ApplicationListResponseCcScheduledApplicationHealthSummary string

High-level health assessment. Only populated for "new_instances" strategy. Based on a sample of target-version instances rather than a full count.

- "pending": Zero target-version instances exist yet. - "healthy": Every sampled target-version instance reports running or active. - "degraded": Some sampled instances remain starting or scheduling. - "unhealthy": One or more sampled instances have failed.

const (
	ApplicationListResponseCcScheduledApplicationHealthSummaryHealthy   ApplicationListResponseCcScheduledApplicationHealthSummary = "healthy"
	ApplicationListResponseCcScheduledApplicationHealthSummaryDegraded  ApplicationListResponseCcScheduledApplicationHealthSummary = "degraded"
	ApplicationListResponseCcScheduledApplicationHealthSummaryUnhealthy ApplicationListResponseCcScheduledApplicationHealthSummary = "unhealthy"
	ApplicationListResponseCcScheduledApplicationHealthSummaryPending   ApplicationListResponseCcScheduledApplicationHealthSummary = "pending"
)

func (ApplicationListResponseCcScheduledApplicationHealthSummary) IsKnown

type ApplicationListResponseCcScheduledApplicationObservability

type ApplicationListResponseCcScheduledApplicationObservability struct {
	// Observability logging settings.
	Logs ApplicationListResponseCcScheduledApplicationObservabilityLogs `json:"logs"`
	JSON applicationListResponseCcScheduledApplicationObservabilityJSON `json:"-"`
}

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

func (*ApplicationListResponseCcScheduledApplicationObservability) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationObservabilityLogs

type ApplicationListResponseCcScheduledApplicationObservabilityLogs struct {
	Enabled bool                                                               `json:"enabled"`
	JSON    applicationListResponseCcScheduledApplicationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationListResponseCcScheduledApplicationObservabilityLogs) UnmarshalJSON

type ApplicationListResponseCcScheduledApplicationSchedulingPolicy

type ApplicationListResponseCcScheduledApplicationSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationListResponseCcScheduledApplicationSchedulingPolicyDefault       ApplicationListResponseCcScheduledApplicationSchedulingPolicy = "default"
	ApplicationListResponseCcScheduledApplicationSchedulingPolicyDurableObject ApplicationListResponseCcScheduledApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationListResponseCcScheduledApplicationSchedulingPolicy) IsKnown

type ApplicationListResponseSchedulingPolicy

type ApplicationListResponseSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationListResponseSchedulingPolicyDefault       ApplicationListResponseSchedulingPolicy = "default"
	ApplicationListResponseSchedulingPolicyDurableObject ApplicationListResponseSchedulingPolicy = "durable_object"
)

func (ApplicationListResponseSchedulingPolicy) IsKnown

type ApplicationListResponseUnion

type ApplicationListResponseUnion interface {
	// contains filtered or unexported methods
}

The public Containers API returns an application.

Union satisfied by ApplicationListResponseCcScheduledApplication or ApplicationListResponseCcDurableObjectApplication.

type ApplicationNewParams

type ApplicationNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Create a Containers application. Set `scheduling_policy` to `default` for a
	// scheduler-backed application with deployment configuration, instance counts,
	// constraints, versions, and rollouts. Set it to `durable_object` for a Durable
	// Object-managed application where each Durable Object creates and manages the
	// lifecycle of its container instance. For `durable_object` requests, supply
	// `name`, `scheduling_policy`, and `durable_objects`, with optional
	// `configuration` and top-level `observability` settings.
	Body ApplicationNewParamsBodyUnion `json:"body" api:"required"`
}

func (ApplicationNewParams) MarshalJSON

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

type ApplicationNewParamsBody

type ApplicationNewParamsBody struct {
	// The name for this application.
	Name param.Field[string] `json:"name" api:"required"`
	// Selects a scheduler-backed application. Use `default` when the Containers
	// scheduler should maintain the requested number of instances and manage
	// deployment configuration, placement, scaling, versions, and rollouts.
	SchedulingPolicy param.Field[ApplicationNewParamsBodySchedulingPolicy] `json:"scheduling_policy" api:"required"`
	Configuration    param.Field[interface{}]                              `json:"configuration"`
	Constraints      param.Field[interface{}]                              `json:"constraints"`
	DurableObjects   param.Field[interface{}]                              `json:"durable_objects"`
	// The initial number of deployments to create.
	Instances param.Field[int64] `json:"instances"`
	// Sets the maximum number of instances that the application can run.
	MaxInstances  param.Field[int64]       `json:"max_instances"`
	Observability param.Field[interface{}] `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod param.Field[int64] `json:"rollout_active_grace_period"`
}

Create a Containers application. Set `scheduling_policy` to `default` for a scheduler-backed application with deployment configuration, instance counts, constraints, versions, and rollouts. Set it to `durable_object` for a Durable Object-managed application where each Durable Object creates and manages the lifecycle of its container instance. For `durable_object` requests, supply `name`, `scheduling_policy`, and `durable_objects`, with optional `configuration` and top-level `observability` settings.

func (ApplicationNewParamsBody) MarshalJSON

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

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequest

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequest struct {
	// The customer-owned Durable Object namespace that owns this application and its
	// instances.
	DurableObjects param.Field[ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjectsUnion] `json:"durable_objects" api:"required"`
	// The name for this application.
	Name param.Field[string] `json:"name" api:"required"`
	// Selects a Durable Object-managed application. Each Durable Object creates and
	// manages the lifecycle of its container instance. Configure application-wide
	// observability settings here. Deployment configuration, scaling, placement
	// constraints, versions, and rollouts do not apply.
	SchedulingPolicy param.Field[ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestSchedulingPolicy] `json:"scheduling_policy" api:"required"`
	// Configuration for a Durable Object-managed application.
	Configuration param.Field[ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfiguration] `json:"configuration"`
	// Application-wide logging settings for a Durable Object-managed application. The
	// application publishes these settings to its runtime metadata. Updating them does
	// not create a deployment or rollout.
	Observability param.Field[ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservability] `json:"observability"`
}

Create a Durable Object-managed Containers application. Each Durable Object creates and manages the lifecycle of its container instance. Supply `name`, `scheduling_policy`, and `durable_objects`, with optional `configuration` and top-level `observability` settings. Deployment configuration, instance counts, scaling, constraints, versions, and rollouts do not apply.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequest) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfiguration

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfiguration struct {
	AuthorizedKeys param.Field[[]ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationAuthorizedKey] `json:"authorized_keys"`
	// Configuration properties for connecting with SSH to a container using Wrangler.
	WranglerSSH param.Field[ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationWranglerSSH] `json:"wrangler_ssh"`
}

Configuration for a Durable Object-managed application.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfiguration) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationAuthorizedKey

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey param.Field[string] `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name param.Field[string] `json:"name"`
}

User-provided SSH public key.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationAuthorizedKey) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationWranglerSSH

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationWranglerSSH struct {
	Enabled param.Field[bool]  `json:"enabled"`
	Port    param.Field[int64] `json:"port"`
}

Configuration properties for connecting with SSH to a container using Wrangler.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestConfigurationWranglerSSH) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjects

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjects struct {
	// The class name of the durable object.
	ClassName param.Field[string] `json:"class_name"`
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID param.Field[string] `json:"namespace_id"`
	// The script name where the durable object class is defined.
	ScriptName param.Field[string] `json:"script_name"`
}

The customer-owned Durable Object namespace that owns this application and its instances.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjects) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjectsCcDurableObjectsConfigurationNamespaceID

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjectsCcDurableObjectsConfigurationNamespaceID struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}

Durable object configuration using a namespace ID.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjectsCcDurableObjectsConfigurationNamespaceID) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjectsCcDurableObjectsConfigurationScriptAndClass

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjectsCcDurableObjectsConfigurationScriptAndClass struct {
	// The class name of the durable object.
	ClassName param.Field[string] `json:"class_name" api:"required"`
	// The script name where the durable object class is defined.
	ScriptName param.Field[string] `json:"script_name" api:"required"`
}

Durable object configuration using script and class names.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestDurableObjectsCcDurableObjectsConfigurationScriptAndClass) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservability

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservability struct {
	// Application-wide logging settings.
	Logs param.Field[ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservabilityLogs] `json:"logs"`
}

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservability) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservabilityLogs

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservabilityLogs struct {
	Enabled param.Field[bool] `json:"enabled"`
}

Application-wide logging settings.

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestObservabilityLogs) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestSchedulingPolicy

type ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestSchedulingPolicy string

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

const (
	ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestSchedulingPolicyDurableObject ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestSchedulingPolicy = "durable_object"
)

func (ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequestSchedulingPolicy) IsKnown

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequest

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequest struct {
	// Defines the deployment configuration for every deployment in this application.
	Configuration param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfiguration] `json:"configuration" api:"required"`
	// The initial number of deployments to create.
	Instances param.Field[int64] `json:"instances" api:"required"`
	// Sets the maximum number of instances that the application can run.
	MaxInstances param.Field[int64] `json:"max_instances" api:"required"`
	// The name for this application.
	Name param.Field[string] `json:"name" api:"required"`
	// Selects a scheduler-backed application. Use `default` when the Containers
	// scheduler should maintain the requested number of instances and manage
	// deployment configuration, placement, scaling, versions, and rollouts.
	SchedulingPolicy param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestSchedulingPolicy] `json:"scheduling_policy" api:"required"`
	Constraints      param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConstraints]      `json:"constraints"`
	// Optionally associates this scheduler-backed application with a Durable Object
	// namespace.
	DurableObjects param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjectsUnion] `json:"durable_objects"`
	// Top-level observability settings for the application. This field is mutually
	// exclusive with configuration.observability.
	Observability param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservability] `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod param.Field[int64] `json:"rollout_active_grace_period"`
}

Create a scheduler-backed Containers application. The Containers scheduler maintains the requested instance count and applies deployment configuration, placement, scaling, versions, and rollouts.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequest) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfiguration

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfiguration struct {
	// Image url.
	Image          param.Field[string]                                                                                            `json:"image" api:"required"`
	AuthorizedKeys param.Field[[]ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationAuthorizedKey] `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command param.Field[[]string] `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint param.Field[[]string] `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables param.Field[[]ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationEnvironmentVariable] `json:"environment_variables"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType] `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservability] `json:"observability"`
}

Defines the deployment configuration for every deployment in this application.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfiguration) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationAuthorizedKey

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey param.Field[string] `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name param.Field[string] `json:"name"`
}

User-provided SSH public key.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationAuthorizedKey) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationEnvironmentVariable

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name param.Field[string] `json:"name" api:"required"`
	// An environment variable value.
	Value param.Field[string] `json:"value" api:"required"`
}

An environment variable with a value set.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationEnvironmentVariable) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceTypeLite      ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType = "lite"
	ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceTypeBasic     ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType = "basic"
	ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceTypeStandard1 ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType = "standard-1"
	ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceTypeStandard2 ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType = "standard-2"
	ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceTypeStandard3 ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType = "standard-3"
	ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceTypeStandard4 ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType = "standard-4"
)

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationInstanceType) IsKnown

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservability

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservability struct {
	// Observability logging settings.
	Logs param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservabilityLogs] `json:"logs"`
}

Settings for deployment observability such as logging.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservability) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservabilityLogs

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservabilityLogs struct {
	Enabled param.Field[bool] `json:"enabled"`
}

Observability logging settings.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConfigurationObservabilityLogs) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConstraints

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConstraints struct {
	// Restricts placement to datacenters in the selected jurisdiction. Choose "eu",
	// "fedramp", or "us". When combined with regions, EU supports EEUR and WEUR while
	// FedRAMP and US support ENAM and WNAM.
	Jurisdiction param.Field[string]   `json:"jurisdiction"`
	Regions      param.Field[[]string] `json:"regions"`
}

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestConstraints) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjects

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjects struct {
	// The class name of the durable object.
	ClassName param.Field[string] `json:"class_name"`
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID param.Field[string] `json:"namespace_id"`
	// The script name where the durable object class is defined.
	ScriptName param.Field[string] `json:"script_name"`
}

Optionally associates this scheduler-backed application with a Durable Object namespace.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjects) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjectsCcDurableObjectsConfigurationNamespaceID

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjectsCcDurableObjectsConfigurationNamespaceID struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}

Durable object configuration using a namespace ID.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjectsCcDurableObjectsConfigurationNamespaceID) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjectsCcDurableObjectsConfigurationScriptAndClass

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjectsCcDurableObjectsConfigurationScriptAndClass struct {
	// The class name of the durable object.
	ClassName param.Field[string] `json:"class_name" api:"required"`
	// The script name where the durable object class is defined.
	ScriptName param.Field[string] `json:"script_name" api:"required"`
}

Durable object configuration using script and class names.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestDurableObjectsCcDurableObjectsConfigurationScriptAndClass) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservability

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservability struct {
	// Observability logging settings.
	Logs param.Field[ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservabilityLogs] `json:"logs"`
}

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservability) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservabilityLogs

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservabilityLogs struct {
	Enabled param.Field[bool] `json:"enabled"`
}

Observability logging settings.

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestObservabilityLogs) MarshalJSON

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestSchedulingPolicy

type ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestSchedulingPolicy string

Selects a scheduler-backed application. Use `default` when the Containers scheduler should maintain the requested number of instances and manage deployment configuration, placement, scaling, versions, and rollouts.

const (
	ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestSchedulingPolicyDefault ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestSchedulingPolicy = "default"
)

func (ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequestSchedulingPolicy) IsKnown

type ApplicationNewParamsBodySchedulingPolicy

type ApplicationNewParamsBodySchedulingPolicy string

Selects a scheduler-backed application. Use `default` when the Containers scheduler should maintain the requested number of instances and manage deployment configuration, placement, scaling, versions, and rollouts.

const (
	ApplicationNewParamsBodySchedulingPolicyDefault       ApplicationNewParamsBodySchedulingPolicy = "default"
	ApplicationNewParamsBodySchedulingPolicyDurableObject ApplicationNewParamsBodySchedulingPolicy = "durable_object"
)

func (ApplicationNewParamsBodySchedulingPolicy) IsKnown

type ApplicationNewParamsBodyUnion

type ApplicationNewParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Create a Containers application. Set `scheduling_policy` to `default` for a scheduler-backed application with deployment configuration, instance counts, constraints, versions, and rollouts. Set it to `durable_object` for a Durable Object-managed application where each Durable Object creates and manages the lifecycle of its container instance. For `durable_object` requests, supply `name`, `scheduling_policy`, and `durable_objects`, with optional `configuration` and top-level `observability` settings.

Satisfied by containers.ApplicationNewParamsBodyCcContainersCreateScheduledApplicationRequest, containers.ApplicationNewParamsBodyCcContainersCreateDurableObjectApplicationRequest, ApplicationNewParamsBody.

type ApplicationNewResponse

type ApplicationNewResponse struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationNewResponseSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string `json:"active_rollout_id"`
	// This field can have the runtime type of
	// [ApplicationNewResponseCcScheduledApplicationConfiguration],
	// [ApplicationNewResponseCcDurableObjectApplicationConfiguration].
	Configuration interface{} `json:"configuration"`
	// This field can have the runtime type of
	// [ApplicationNewResponseCcScheduledApplicationConstraints].
	Constraints interface{} `json:"constraints"`
	// This field can have the runtime type of
	// [ApplicationNewResponseCcScheduledApplicationDurableObjects],
	// [ApplicationNewResponseCcDurableObjectApplicationDurableObjects].
	DurableObjects interface{} `json:"durable_objects"`
	// This field can have the runtime type of
	// [ApplicationNewResponseCcScheduledApplicationHealth],
	// [ApplicationNewResponseCcDurableObjectApplicationHealth].
	Health interface{} `json:"health"`
	// Number of deployments to create.
	Instances int64 `json:"instances"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// This field can have the runtime type of
	// [ApplicationNewResponseCcScheduledApplicationObservability],
	// [ApplicationNewResponseCcDurableObjectApplicationObservability].
	Observability interface{} `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                      `json:"rollout_active_grace_period"`
	Version                  int64                      `json:"version"`
	JSON                     applicationNewResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

The public Containers API returns an application.

func (ApplicationNewResponse) AsUnion

AsUnion returns a ApplicationNewResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are ApplicationNewResponseCcScheduledApplication, ApplicationNewResponseCcDurableObjectApplication.

func (*ApplicationNewResponse) UnmarshalJSON

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

type ApplicationNewResponseCcDurableObjectApplication

type ApplicationNewResponseCcDurableObjectApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Durable object configuration using a namespace ID.
	DurableObjects ApplicationNewResponseCcDurableObjectApplicationDurableObjects `json:"durable_objects" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// Selects a Durable Object-managed application. Each Durable Object creates and
	// manages the lifecycle of its container instance. Configure application-wide
	// observability settings here. Deployment configuration, scaling, placement
	// constraints, versions, and rollouts do not apply.
	SchedulingPolicy ApplicationNewResponseCcDurableObjectApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	// Application-wide settings for a Durable Object-managed application.
	Configuration ApplicationNewResponseCcDurableObjectApplicationConfiguration `json:"configuration"`
	// Aggregate current activity for the latest observed placement of each instance.
	// Runtime snapshots feed periodic background sweeps. Counts refresh after each
	// complete sweep. Instance listings retain their separate three-month history for
	// failure discovery.
	Health ApplicationNewResponseCcDurableObjectApplicationHealth `json:"health"`
	// Application-wide logging settings for a Durable Object-managed application. The
	// application publishes these settings to its runtime metadata. Updating them does
	// not create a deployment or rollout.
	Observability ApplicationNewResponseCcDurableObjectApplicationObservability `json:"observability"`
	JSON          applicationNewResponseCcDurableObjectApplicationJSON          `json:"-"`
}

Each Durable Object creates and manages the lifecycle of its container instance.

func (*ApplicationNewResponseCcDurableObjectApplication) UnmarshalJSON

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

type ApplicationNewResponseCcDurableObjectApplicationConfiguration

type ApplicationNewResponseCcDurableObjectApplicationConfiguration struct {
	AuthorizedKeys []ApplicationNewResponseCcDurableObjectApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// Configuration properties for connecting with SSH to a container using Wrangler.
	WranglerSSH ApplicationNewResponseCcDurableObjectApplicationConfigurationWranglerSSH `json:"wrangler_ssh"`
	JSON        applicationNewResponseCcDurableObjectApplicationConfigurationJSON        `json:"-"`
}

Application-wide settings for a Durable Object-managed application.

func (*ApplicationNewResponseCcDurableObjectApplicationConfiguration) UnmarshalJSON

type ApplicationNewResponseCcDurableObjectApplicationConfigurationAuthorizedKey

type ApplicationNewResponseCcDurableObjectApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                         `json:"name"`
	JSON applicationNewResponseCcDurableObjectApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationNewResponseCcDurableObjectApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationNewResponseCcDurableObjectApplicationConfigurationWranglerSSH

type ApplicationNewResponseCcDurableObjectApplicationConfigurationWranglerSSH struct {
	Enabled bool                                                                         `json:"enabled"`
	Port    int64                                                                        `json:"port"`
	JSON    applicationNewResponseCcDurableObjectApplicationConfigurationWranglerSSHJSON `json:"-"`
}

Configuration properties for connecting with SSH to a container using Wrangler.

func (*ApplicationNewResponseCcDurableObjectApplicationConfigurationWranglerSSH) UnmarshalJSON

type ApplicationNewResponseCcDurableObjectApplicationDurableObjects

type ApplicationNewResponseCcDurableObjectApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                             `json:"namespace_id" api:"required"`
	JSON        applicationNewResponseCcDurableObjectApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration using a namespace ID.

func (*ApplicationNewResponseCcDurableObjectApplicationDurableObjects) UnmarshalJSON

type ApplicationNewResponseCcDurableObjectApplicationHealth

type ApplicationNewResponseCcDurableObjectApplicationHealth struct {
	// Counts of observed non-terminal instances.
	Instances ApplicationNewResponseCcDurableObjectApplicationHealthInstances `json:"instances" api:"required"`
	// Present as pending until the first activity sweep completes; omitted afterward.
	Summary ApplicationNewResponseCcDurableObjectApplicationHealthSummary `json:"summary"`
	JSON    applicationNewResponseCcDurableObjectApplicationHealthJSON    `json:"-"`
}

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

func (*ApplicationNewResponseCcDurableObjectApplicationHealth) UnmarshalJSON

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

type ApplicationNewResponseCcDurableObjectApplicationHealthInstances

type ApplicationNewResponseCcDurableObjectApplicationHealthInstances struct {
	// Number of instances whose runtime reports running or stopping.
	Active int64 `json:"active" api:"required"`
	// Number of instances whose runtime reports starting.
	Starting int64                                                               `json:"starting" api:"required"`
	JSON     applicationNewResponseCcDurableObjectApplicationHealthInstancesJSON `json:"-"`
}

Counts of observed non-terminal instances.

func (*ApplicationNewResponseCcDurableObjectApplicationHealthInstances) UnmarshalJSON

type ApplicationNewResponseCcDurableObjectApplicationHealthSummary

type ApplicationNewResponseCcDurableObjectApplicationHealthSummary string

Present as pending until the first activity sweep completes; omitted afterward.

const (
	ApplicationNewResponseCcDurableObjectApplicationHealthSummaryPending ApplicationNewResponseCcDurableObjectApplicationHealthSummary = "pending"
)

func (ApplicationNewResponseCcDurableObjectApplicationHealthSummary) IsKnown

type ApplicationNewResponseCcDurableObjectApplicationObservability

type ApplicationNewResponseCcDurableObjectApplicationObservability struct {
	// Application-wide logging settings.
	Logs ApplicationNewResponseCcDurableObjectApplicationObservabilityLogs `json:"logs"`
	JSON applicationNewResponseCcDurableObjectApplicationObservabilityJSON `json:"-"`
}

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

func (*ApplicationNewResponseCcDurableObjectApplicationObservability) UnmarshalJSON

type ApplicationNewResponseCcDurableObjectApplicationObservabilityLogs

type ApplicationNewResponseCcDurableObjectApplicationObservabilityLogs struct {
	Enabled bool                                                                  `json:"enabled"`
	JSON    applicationNewResponseCcDurableObjectApplicationObservabilityLogsJSON `json:"-"`
}

Application-wide logging settings.

func (*ApplicationNewResponseCcDurableObjectApplicationObservabilityLogs) UnmarshalJSON

type ApplicationNewResponseCcDurableObjectApplicationSchedulingPolicy

type ApplicationNewResponseCcDurableObjectApplicationSchedulingPolicy string

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

const (
	ApplicationNewResponseCcDurableObjectApplicationSchedulingPolicyDurableObject ApplicationNewResponseCcDurableObjectApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationNewResponseCcDurableObjectApplicationSchedulingPolicy) IsKnown

type ApplicationNewResponseCcScheduledApplication

type ApplicationNewResponseCcScheduledApplication struct {
	// An Application ID represents an identifier of an application.
	ID string `json:"id" api:"required"`
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// User-specified container configuration.
	Configuration ApplicationNewResponseCcScheduledApplicationConfiguration `json:"configuration" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// Number of deployments to create.
	Instances int64 `json:"instances" api:"required"`
	// The application name.
	Name string `json:"name" api:"required"`
	// The scheduling policy to use for an application.
	SchedulingPolicy ApplicationNewResponseCcScheduledApplicationSchedulingPolicy `json:"scheduling_policy" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	UpdatedAt string `json:"updated_at" api:"required"`
	Version   int64  `json:"version" api:"required"`
	// An identifier for a specific rollout within an application.
	ActiveRolloutID string                                                  `json:"active_rollout_id"`
	Constraints     ApplicationNewResponseCcScheduledApplicationConstraints `json:"constraints"`
	// Durable object configuration stored on and returned from a Cloudchamber
	// application.
	DurableObjects ApplicationNewResponseCcScheduledApplicationDurableObjects `json:"durable_objects"`
	Health         ApplicationNewResponseCcScheduledApplicationHealth         `json:"health"`
	// Maximum number of instances the application allows. This is relevant for
	// applications that auto-scale.
	MaxInstances int64 `json:"max_instances"`
	// Top-level observability settings for the application. This field is mutually
	// exclusive with configuration.observability.
	Observability ApplicationNewResponseCcScheduledApplicationObservability `json:"observability"`
	// Grace period for active instances to stay alive before becoming eligible for
	// shutdown signal due to a rollout, in seconds. Defaults to 0.
	RolloutActiveGracePeriod int64                                            `json:"rollout_active_grace_period"`
	JSON                     applicationNewResponseCcScheduledApplicationJSON `json:"-"`
}

Describes an application and the parameters that govern how it places its instances.

func (*ApplicationNewResponseCcScheduledApplication) UnmarshalJSON

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

type ApplicationNewResponseCcScheduledApplicationConfiguration

type ApplicationNewResponseCcScheduledApplicationConfiguration struct {
	// Image url.
	Image          string                                                                   `json:"image" api:"required"`
	AuthorizedKeys []ApplicationNewResponseCcScheduledApplicationConfigurationAuthorizedKey `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command []string `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint []string `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables []ApplicationNewResponseCcScheduledApplicationConfigurationEnvironmentVariable `json:"environment_variables"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability ApplicationNewResponseCcScheduledApplicationConfigurationObservability `json:"observability"`
	JSON          applicationNewResponseCcScheduledApplicationConfigurationJSON          `json:"-"`
}

User-specified container configuration.

func (*ApplicationNewResponseCcScheduledApplicationConfiguration) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationConfigurationAuthorizedKey

type ApplicationNewResponseCcScheduledApplicationConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                                     `json:"name"`
	JSON applicationNewResponseCcScheduledApplicationConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationNewResponseCcScheduledApplicationConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationConfigurationEnvironmentVariable

type ApplicationNewResponseCcScheduledApplicationConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name string `json:"name" api:"required"`
	// An environment variable value.
	Value string                                                                           `json:"value" api:"required"`
	JSON  applicationNewResponseCcScheduledApplicationConfigurationEnvironmentVariableJSON `json:"-"`
}

An environment variable with a value set.

func (*ApplicationNewResponseCcScheduledApplicationConfigurationEnvironmentVariable) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType

type ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationNewResponseCcScheduledApplicationConfigurationInstanceTypeLite      ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType = "lite"
	ApplicationNewResponseCcScheduledApplicationConfigurationInstanceTypeBasic     ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType = "basic"
	ApplicationNewResponseCcScheduledApplicationConfigurationInstanceTypeStandard1 ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType = "standard-1"
	ApplicationNewResponseCcScheduledApplicationConfigurationInstanceTypeStandard2 ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType = "standard-2"
	ApplicationNewResponseCcScheduledApplicationConfigurationInstanceTypeStandard3 ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType = "standard-3"
	ApplicationNewResponseCcScheduledApplicationConfigurationInstanceTypeStandard4 ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType = "standard-4"
)

func (ApplicationNewResponseCcScheduledApplicationConfigurationInstanceType) IsKnown

type ApplicationNewResponseCcScheduledApplicationConfigurationObservability

type ApplicationNewResponseCcScheduledApplicationConfigurationObservability struct {
	// Observability logging settings.
	Logs ApplicationNewResponseCcScheduledApplicationConfigurationObservabilityLogs `json:"logs"`
	JSON applicationNewResponseCcScheduledApplicationConfigurationObservabilityJSON `json:"-"`
}

Settings for deployment observability such as logging.

func (*ApplicationNewResponseCcScheduledApplicationConfigurationObservability) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationConfigurationObservabilityLogs

type ApplicationNewResponseCcScheduledApplicationConfigurationObservabilityLogs struct {
	Enabled bool                                                                           `json:"enabled"`
	JSON    applicationNewResponseCcScheduledApplicationConfigurationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationNewResponseCcScheduledApplicationConfigurationObservabilityLogs) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationConstraints

type ApplicationNewResponseCcScheduledApplicationConstraints struct {
	// Restricts placement to datacenters in the selected jurisdiction. Choose "eu",
	// "fedramp", or "us". When combined with regions, EU supports EEUR and WEUR while
	// FedRAMP and US support ENAM and WNAM.
	Jurisdiction string                                                      `json:"jurisdiction"`
	Regions      []string                                                    `json:"regions"`
	JSON         applicationNewResponseCcScheduledApplicationConstraintsJSON `json:"-"`
}

func (*ApplicationNewResponseCcScheduledApplicationConstraints) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationDurableObjects

type ApplicationNewResponseCcScheduledApplicationDurableObjects struct {
	// The namespace ID of the durable object namespace to use for this application.
	NamespaceID string                                                         `json:"namespace_id" api:"required"`
	JSON        applicationNewResponseCcScheduledApplicationDurableObjectsJSON `json:"-"`
}

Durable object configuration stored on and returned from a Cloudchamber application.

func (*ApplicationNewResponseCcScheduledApplicationDurableObjects) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationHealth

type ApplicationNewResponseCcScheduledApplicationHealth struct {
	Errors []ApplicationNewResponseCcScheduledApplicationHealthError `json:"errors" api:"required"`
	// Shows a count of application instance states.
	Instances ApplicationNewResponseCcScheduledApplicationHealthInstances `json:"instances" api:"required"`
	// High-level health assessment. Only populated for "new_instances" strategy. Based
	// on a sample of target-version instances rather than a full count.
	//
	// - "pending": Zero target-version instances exist yet.
	// - "healthy": Every sampled target-version instance reports running or active.
	// - "degraded": Some sampled instances remain starting or scheduling.
	// - "unhealthy": One or more sampled instances have failed.
	Summary ApplicationNewResponseCcScheduledApplicationHealthSummary `json:"summary"`
	JSON    applicationNewResponseCcScheduledApplicationHealthJSON    `json:"-"`
}

func (*ApplicationNewResponseCcScheduledApplicationHealth) UnmarshalJSON

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

type ApplicationNewResponseCcScheduledApplicationHealthError

type ApplicationNewResponseCcScheduledApplicationHealthError struct {
	// An event within a Placement or a Job.
	Event ApplicationNewResponseCcScheduledApplicationHealthErrorsEvent `json:"event" api:"required"`
	// An instance ID represents an identifier of an instance configuration that
	// maintains an underlying placement.
	InstanceID string                                                      `json:"instance_id" api:"required"`
	JSON       applicationNewResponseCcScheduledApplicationHealthErrorJSON `json:"-"`
}

func (*ApplicationNewResponseCcScheduledApplicationHealthError) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationHealthErrorsEvent

type ApplicationNewResponseCcScheduledApplicationHealthErrorsEvent struct {
	ID      string                 `json:"id" api:"required"`
	Details map[string]interface{} `json:"details" api:"required"`
	Message string                 `json:"message" api:"required"`
	// Name of the event that describes the kind event that happened.
	//
	//   - SchedulerPlaced: It's the first event that creates a container placement. It
	//     happens when the Containers runtime was able to retrieve deployment resources
	//     and start verifying everything is correct.
	//   - NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the
	//     container.
	//   - VMStarted: It's sent when the Containers runtime starts the VM. The container
	//     might remain unhealthy at this point.
	//   - ImagePulled: It's sent when the Containers runtime pulls the image
	//     successfully.
	//   - ImagePullError: It's sent when the Containers runtime is having issues pulling
	//     the image. The message and details have more information on what happened for
	//     debugging.
	//   - VMFailedToStart: It's sent when the Containers runtime was unable to boot the
	//     VM.
	//   - VMStopping: It's sent when the scheduler is stopping the VM.
	//   - VMStopped: It's sent when the VM finally exits.
	//   - VMFailed: It's sent when the scheduling of the VM failed in the current
	//     location.
	//   - RuntimeStartFailed: It's sent when the runtime hits an internal error.
	//   - SSHStarted: It's sent when the container gains network connectivity and opens
	//     the SSH port. Containers only send this event when SSH keys exist.
	//   - CheckUpdate: Sent when the status of a health or readiness check changes. This
	//     may also affect the health status of the placement.
	//   - DurableObjectConnected: Sent when a durable object instance connects and gains
	//     control of the deployment. This event is only sent for durable object
	//     deployments. It is sent after VMStarted.
	//   - ContainerStarted: It's sent when the container starts running.
	Name         ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName `json:"name" api:"required"`
	StatusChange map[string]interface{}                                            `json:"statusChange" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	Time string                                                            `json:"time" api:"required"`
	Type ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType `json:"type" api:"required"`
	JSON applicationNewResponseCcScheduledApplicationHealthErrorsEventJSON `json:"-"`
}

An event within a Placement or a Job.

func (*ApplicationNewResponseCcScheduledApplicationHealthErrorsEvent) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName

type ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName string

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It's the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the container.
  • VMStarted: It's sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It's sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It's sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It's sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It's sent when the scheduler is stopping the VM.
  • VMStopped: It's sent when the VM finally exits.
  • VMFailed: It's sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It's sent when the runtime hits an internal error.
  • SSHStarted: It's sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It's sent when the container starts running.
const (
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameSchedulerPlaced              ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "SchedulerPlaced"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssigned         ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssigned"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameVmStarted                    ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "VMStarted"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameImagePulled                  ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "ImagePulled"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameImagePullError               ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "ImagePullError"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameVmFailedToStart              ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "VMFailedToStart"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssignmentFailed ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssignmentFailed"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameVmRunning                    ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "VMRunning"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameVmStopping                   ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "VMStopping"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameVmStopped                    ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "VMStopped"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameVmFailed                     ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "VMFailed"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameRuntimeStartFailed           ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "RuntimeStartFailed"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameSSHStarted                   ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "SSHStarted"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameServiceHealthUpdates         ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "ServiceHealthUpdates"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameCheckUpdate                  ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "CheckUpdate"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameDurableObjectConnected       ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "DurableObjectConnected"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventNameContainerStarted             ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName = "ContainerStarted"
)

func (ApplicationNewResponseCcScheduledApplicationHealthErrorsEventName) IsKnown

type ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType

type ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType string
const (
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventTypeInfo        ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType = "Info"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventTypeError       ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType = "Error"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventTypeWarn        ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType = "Warn"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventTypeUserError   ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType = "UserError"
	ApplicationNewResponseCcScheduledApplicationHealthErrorsEventTypeSystemError ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType = "SystemError"
)

func (ApplicationNewResponseCcScheduledApplicationHealthErrorsEventType) IsKnown

type ApplicationNewResponseCcScheduledApplicationHealthInstances

type ApplicationNewResponseCcScheduledApplicationHealthInstances struct {
	// Number of instances whose runtime reports the container as running
	// (container_status = "running"). This is a subset of the placements that remain
	// up: an instance that is already bound to a Durable Object and serving traffic is
	// counted under "assigned" until its container_status catches up to "running", so
	// container_status can briefly lag Durable Object attachment under churn. To
	// estimate running, Durable-Object-bound instances, sum "active" + "assigned"
	// rather than reading "active" alone.
	Active int64 `json:"active" api:"required"`
	// Number of instances bound to a Durable Object with a running placement whose
	// container_status remains behind "running". These count as live, serving
	// instances; "active" + "assigned" approximates the running, Durable-Object-bound
	// count.
	Assigned int64                                                           `json:"assigned" api:"required"`
	JSON     applicationNewResponseCcScheduledApplicationHealthInstancesJSON `json:"-"`
}

Shows a count of application instance states.

func (*ApplicationNewResponseCcScheduledApplicationHealthInstances) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationHealthSummary

type ApplicationNewResponseCcScheduledApplicationHealthSummary string

High-level health assessment. Only populated for "new_instances" strategy. Based on a sample of target-version instances rather than a full count.

- "pending": Zero target-version instances exist yet. - "healthy": Every sampled target-version instance reports running or active. - "degraded": Some sampled instances remain starting or scheduling. - "unhealthy": One or more sampled instances have failed.

const (
	ApplicationNewResponseCcScheduledApplicationHealthSummaryHealthy   ApplicationNewResponseCcScheduledApplicationHealthSummary = "healthy"
	ApplicationNewResponseCcScheduledApplicationHealthSummaryDegraded  ApplicationNewResponseCcScheduledApplicationHealthSummary = "degraded"
	ApplicationNewResponseCcScheduledApplicationHealthSummaryUnhealthy ApplicationNewResponseCcScheduledApplicationHealthSummary = "unhealthy"
	ApplicationNewResponseCcScheduledApplicationHealthSummaryPending   ApplicationNewResponseCcScheduledApplicationHealthSummary = "pending"
)

func (ApplicationNewResponseCcScheduledApplicationHealthSummary) IsKnown

type ApplicationNewResponseCcScheduledApplicationObservability

type ApplicationNewResponseCcScheduledApplicationObservability struct {
	// Observability logging settings.
	Logs ApplicationNewResponseCcScheduledApplicationObservabilityLogs `json:"logs"`
	JSON applicationNewResponseCcScheduledApplicationObservabilityJSON `json:"-"`
}

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

func (*ApplicationNewResponseCcScheduledApplicationObservability) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationObservabilityLogs

type ApplicationNewResponseCcScheduledApplicationObservabilityLogs struct {
	Enabled bool                                                              `json:"enabled"`
	JSON    applicationNewResponseCcScheduledApplicationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationNewResponseCcScheduledApplicationObservabilityLogs) UnmarshalJSON

type ApplicationNewResponseCcScheduledApplicationSchedulingPolicy

type ApplicationNewResponseCcScheduledApplicationSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationNewResponseCcScheduledApplicationSchedulingPolicyDefault       ApplicationNewResponseCcScheduledApplicationSchedulingPolicy = "default"
	ApplicationNewResponseCcScheduledApplicationSchedulingPolicyDurableObject ApplicationNewResponseCcScheduledApplicationSchedulingPolicy = "durable_object"
)

func (ApplicationNewResponseCcScheduledApplicationSchedulingPolicy) IsKnown

type ApplicationNewResponseEnvelope

type ApplicationNewResponseEnvelope struct {
	Errors   []ApplicationNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ApplicationNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// The public Containers API returns an application.
	Result ApplicationNewResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                               `json:"success" api:"required"`
	JSON    applicationNewResponseEnvelopeJSON `json:"-"`
}

func (*ApplicationNewResponseEnvelope) UnmarshalJSON

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

type ApplicationNewResponseEnvelopeErrors

type ApplicationNewResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ApplicationNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             applicationNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ApplicationNewResponseEnvelopeErrors) UnmarshalJSON

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

type ApplicationNewResponseEnvelopeErrorsSource

type ApplicationNewResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    applicationNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ApplicationNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ApplicationNewResponseEnvelopeMessages

type ApplicationNewResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ApplicationNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             applicationNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ApplicationNewResponseEnvelopeMessages) UnmarshalJSON

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

type ApplicationNewResponseEnvelopeMessagesSource

type ApplicationNewResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    applicationNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ApplicationNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ApplicationNewResponseSchedulingPolicy

type ApplicationNewResponseSchedulingPolicy string

The scheduling policy to use for an application.

const (
	ApplicationNewResponseSchedulingPolicyDefault       ApplicationNewResponseSchedulingPolicy = "default"
	ApplicationNewResponseSchedulingPolicyDurableObject ApplicationNewResponseSchedulingPolicy = "durable_object"
)

func (ApplicationNewResponseSchedulingPolicy) IsKnown

type ApplicationNewResponseUnion

type ApplicationNewResponseUnion interface {
	// contains filtered or unexported methods
}

The public Containers API returns an application.

Union satisfied by ApplicationNewResponseCcScheduledApplication or ApplicationNewResponseCcDurableObjectApplication.

type ApplicationRolloutNewParams

type ApplicationRolloutNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Description of the rollout process.
	Description param.Field[string] `json:"description" api:"required"`
	// Strategy used for the rollout.
	//
	//   - "rolling": Step-based rollout with health gates. Actively replaces instances
	//     to reach each step's target percentage.
	//   - "new_instances": Percentage control over version distribution. Version sync
	//     actively replaces instances to match the configured percentage. The
	//     "full_auto" kind advances through fixed percentage targets after
	//     target-version health is observed.
	Strategy param.Field[ApplicationRolloutNewParamsStrategy] `json:"strategy" api:"required"`
	// User-specified container configuration changes.
	TargetConfiguration param.Field[ApplicationRolloutNewParamsTargetConfiguration] `json:"target_configuration" api:"required"`
	// Kind of the rollout process. Defaults to "full_auto".
	//
	//   - "full_auto": For rolling rollouts, starts progressing steps upon rollout
	//     creation. For new_instances rollouts, advances percentage targets
	//     automatically after target-version health is observed.
	//   - "full_manual": Requires manually progressing each step in the rollout using
	//     the UpdateRollout's action parameter.
	Kind param.Field[ApplicationRolloutNewParamsKind] `json:"kind"`
	// Initial target version percentage (0-100). Version sync actively replaces
	// instances to match. Required when strategy is "new_instances" and kind is
	// "full_manual". When strategy is "new_instances" and kind is "full_auto", omitted
	// percentage starts at 10% or the smallest percentage that targets at least one
	// instance. Unused for "rolling".
	Percentage param.Field[int64] `json:"percentage"`
	// Percentage of rollout to increase in each step when "steps" is absent.
	// Applicable values: 5, 10, 20, 25, 50, 100. These create rollouts with 20, 10, 5,
	// 4, 2, 1 steps respectively. Only valid for "rolling" strategy.
	StepPercentage param.Field[ApplicationRolloutNewParamsStepPercentage] `json:"step_percentage"`
	// Steps defining the rollout process, used when "step_percentage" is absent.
	// Specify only one of "step_percentage" or "steps" when creating a rollout.
	// "steps" allow granular control over each step. Only valid for "rolling"
	// strategy.
	Steps param.Field[[]ApplicationRolloutNewParamsStep] `json:"steps"`
}

func (ApplicationRolloutNewParams) MarshalJSON

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

type ApplicationRolloutNewParamsKind

type ApplicationRolloutNewParamsKind string

Kind of the rollout process. Defaults to "full_auto".

  • "full_auto": For rolling rollouts, starts progressing steps upon rollout creation. For new_instances rollouts, advances percentage targets automatically after target-version health is observed.
  • "full_manual": Requires manually progressing each step in the rollout using the UpdateRollout's action parameter.
const (
	ApplicationRolloutNewParamsKindFullAuto   ApplicationRolloutNewParamsKind = "full_auto"
	ApplicationRolloutNewParamsKindFullManual ApplicationRolloutNewParamsKind = "full_manual"
)

func (ApplicationRolloutNewParamsKind) IsKnown

type ApplicationRolloutNewParamsStep

type ApplicationRolloutNewParamsStep struct {
	// Description of the rollout step.
	Description param.Field[string]                                   `json:"description" api:"required"`
	StepSize    param.Field[ApplicationRolloutNewParamsStepsStepSize] `json:"step_size" api:"required"`
}

Steps defining the rollout process.

func (ApplicationRolloutNewParamsStep) MarshalJSON

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

type ApplicationRolloutNewParamsStepPercentage

type ApplicationRolloutNewParamsStepPercentage int64

Percentage of rollout to increase in each step when "steps" is absent. Applicable values: 5, 10, 20, 25, 50, 100. These create rollouts with 20, 10, 5, 4, 2, 1 steps respectively. Only valid for "rolling" strategy.

const (
	ApplicationRolloutNewParamsStepPercentage5   ApplicationRolloutNewParamsStepPercentage = 5
	ApplicationRolloutNewParamsStepPercentage10  ApplicationRolloutNewParamsStepPercentage = 10
	ApplicationRolloutNewParamsStepPercentage20  ApplicationRolloutNewParamsStepPercentage = 20
	ApplicationRolloutNewParamsStepPercentage25  ApplicationRolloutNewParamsStepPercentage = 25
	ApplicationRolloutNewParamsStepPercentage50  ApplicationRolloutNewParamsStepPercentage = 50
	ApplicationRolloutNewParamsStepPercentage100 ApplicationRolloutNewParamsStepPercentage = 100
)

func (ApplicationRolloutNewParamsStepPercentage) IsKnown

type ApplicationRolloutNewParamsStepsStepSize

type ApplicationRolloutNewParamsStepsStepSize struct {
	// Percentage of instances affected in this step. Min 10% and Max 100%.
	Percentage param.Field[int64] `json:"percentage" api:"required"`
}

func (ApplicationRolloutNewParamsStepsStepSize) MarshalJSON

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

type ApplicationRolloutNewParamsStrategy

type ApplicationRolloutNewParamsStrategy string

Strategy used for the rollout.

  • "rolling": Step-based rollout with health gates. Actively replaces instances to reach each step's target percentage.
  • "new_instances": Percentage control over version distribution. Version sync actively replaces instances to match the configured percentage. The "full_auto" kind advances through fixed percentage targets after target-version health is observed.
const (
	ApplicationRolloutNewParamsStrategyRolling      ApplicationRolloutNewParamsStrategy = "rolling"
	ApplicationRolloutNewParamsStrategyNewInstances ApplicationRolloutNewParamsStrategy = "new_instances"
)

func (ApplicationRolloutNewParamsStrategy) IsKnown

type ApplicationRolloutNewParamsTargetConfiguration

type ApplicationRolloutNewParamsTargetConfiguration struct {
	AuthorizedKeys param.Field[[]ApplicationRolloutNewParamsTargetConfigurationAuthorizedKey] `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command param.Field[[]string] `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint param.Field[[]string] `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables param.Field[[]ApplicationRolloutNewParamsTargetConfigurationEnvironmentVariable] `json:"environment_variables"`
	// Image url.
	Image param.Field[string] `json:"image"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType param.Field[ApplicationRolloutNewParamsTargetConfigurationInstanceType] `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability param.Field[ApplicationRolloutNewParamsTargetConfigurationObservability] `json:"observability"`
}

User-specified container configuration changes.

func (ApplicationRolloutNewParamsTargetConfiguration) MarshalJSON

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

type ApplicationRolloutNewParamsTargetConfigurationAuthorizedKey

type ApplicationRolloutNewParamsTargetConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey param.Field[string] `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name param.Field[string] `json:"name"`
}

User-provided SSH public key.

func (ApplicationRolloutNewParamsTargetConfigurationAuthorizedKey) MarshalJSON

type ApplicationRolloutNewParamsTargetConfigurationEnvironmentVariable

type ApplicationRolloutNewParamsTargetConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name param.Field[string] `json:"name" api:"required"`
	// An environment variable value.
	Value param.Field[string] `json:"value" api:"required"`
}

An environment variable with a value set.

func (ApplicationRolloutNewParamsTargetConfigurationEnvironmentVariable) MarshalJSON

type ApplicationRolloutNewParamsTargetConfigurationInstanceType

type ApplicationRolloutNewParamsTargetConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationRolloutNewParamsTargetConfigurationInstanceTypeLite      ApplicationRolloutNewParamsTargetConfigurationInstanceType = "lite"
	ApplicationRolloutNewParamsTargetConfigurationInstanceTypeBasic     ApplicationRolloutNewParamsTargetConfigurationInstanceType = "basic"
	ApplicationRolloutNewParamsTargetConfigurationInstanceTypeStandard1 ApplicationRolloutNewParamsTargetConfigurationInstanceType = "standard-1"
	ApplicationRolloutNewParamsTargetConfigurationInstanceTypeStandard2 ApplicationRolloutNewParamsTargetConfigurationInstanceType = "standard-2"
	ApplicationRolloutNewParamsTargetConfigurationInstanceTypeStandard3 ApplicationRolloutNewParamsTargetConfigurationInstanceType = "standard-3"
	ApplicationRolloutNewParamsTargetConfigurationInstanceTypeStandard4 ApplicationRolloutNewParamsTargetConfigurationInstanceType = "standard-4"
)

func (ApplicationRolloutNewParamsTargetConfigurationInstanceType) IsKnown

type ApplicationRolloutNewParamsTargetConfigurationObservability

type ApplicationRolloutNewParamsTargetConfigurationObservability struct {
	// Observability logging settings.
	Logs param.Field[ApplicationRolloutNewParamsTargetConfigurationObservabilityLogs] `json:"logs"`
}

Settings for deployment observability such as logging.

func (ApplicationRolloutNewParamsTargetConfigurationObservability) MarshalJSON

type ApplicationRolloutNewParamsTargetConfigurationObservabilityLogs

type ApplicationRolloutNewParamsTargetConfigurationObservabilityLogs struct {
	Enabled param.Field[bool] `json:"enabled"`
}

Observability logging settings.

func (ApplicationRolloutNewParamsTargetConfigurationObservabilityLogs) MarshalJSON

type ApplicationRolloutNewResponse

type ApplicationRolloutNewResponse struct {
	// An identifier for a specific rollout within an application.
	ID string `json:"id" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// User-specified container configuration changes.
	CurrentConfiguration ApplicationRolloutNewResponseCurrentConfiguration `json:"current_configuration" api:"required"`
	// Current application version before the rollout.
	CurrentVersion int64                               `json:"current_version" api:"required"`
	Description    string                              `json:"description" api:"required"`
	Health         ApplicationRolloutNewResponseHealth `json:"health" api:"required"`
	// Kind of the rollout process.
	//
	//   - "full_auto": For rolling rollouts, starts progressing steps upon rollout
	//     creation. For new_instances rollouts, advances percentage targets
	//     automatically after target-version health is observed.
	//   - "full_manual": Requires manually progressing each step in the rollout using
	//     the UpdateRollout's action paramater.
	//   - "durable_objects_auto": Default when the application is a DO application.
	Kind ApplicationRolloutNewResponseKind `json:"kind" api:"required"`
	// Timestamp of the most recent update to status, health, or progress.
	LastUpdatedAt string `json:"last_updated_at" api:"required"`
	// Current status of the rollout.
	Status ApplicationRolloutNewResponseStatus `json:"status" api:"required"`
	// The rollout strategy.
	//
	//   - "rolling": Step-based rollout with health gates. Actively replaces instances
	//     to reach each step's target percentage. Response includes steps and progress.
	//   - "new_instances": Percentage control over version distribution. Version sync
	//     actively replaces instances to match the configured percentage. "full_auto"
	//     ramps through fixed percentage targets after target-version health is
	//     observed. Response includes percentage, version_distribution, and
	//     health.summary.
	Strategy ApplicationRolloutNewResponseStrategy `json:"strategy" api:"required"`
	// User-specified container configuration changes.
	TargetConfiguration ApplicationRolloutNewResponseTargetConfiguration `json:"target_configuration" api:"required"`
	// Target application version after the rollout is complete and applied to all
	// current instances.
	TargetVersion int64 `json:"target_version" api:"required"`
	// Current target version percentage (0-100). Only present for "new_instances"
	// strategy.
	Percentage int64 `json:"percentage"`
	// Progress details of an application rollout.
	Progress ApplicationRolloutNewResponseProgress `json:"progress"`
	// Timestamp when the rollout started.
	StartedAt time.Time                           `json:"started_at" format:"date-time"`
	Steps     []ApplicationRolloutNewResponseStep `json:"steps"`
	// Version percentage distribution. Only present for "new_instances" strategy. For
	// "rolling" strategy, see progress.version_distribution instead.
	VersionDistribution ApplicationRolloutNewResponseVersionDistribution `json:"version_distribution"`
	JSON                applicationRolloutNewResponseJSON                `json:"-"`
}

Represents the status and metadata of a rollout process for an application. For "rolling" strategy: includes steps and progress with instance counts. For "new_instances" strategy: the response omits steps and progress. Use percentage, version_distribution, and health.summary for status.

func (*ApplicationRolloutNewResponse) UnmarshalJSON

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

type ApplicationRolloutNewResponseCurrentConfiguration

type ApplicationRolloutNewResponseCurrentConfiguration struct {
	AuthorizedKeys []ApplicationRolloutNewResponseCurrentConfigurationAuthorizedKey `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command []string `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint []string `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables []ApplicationRolloutNewResponseCurrentConfigurationEnvironmentVariable `json:"environment_variables"`
	// Image url.
	Image string `json:"image"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType ApplicationRolloutNewResponseCurrentConfigurationInstanceType `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability ApplicationRolloutNewResponseCurrentConfigurationObservability `json:"observability"`
	JSON          applicationRolloutNewResponseCurrentConfigurationJSON          `json:"-"`
}

User-specified container configuration changes.

func (*ApplicationRolloutNewResponseCurrentConfiguration) UnmarshalJSON

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

type ApplicationRolloutNewResponseCurrentConfigurationAuthorizedKey

type ApplicationRolloutNewResponseCurrentConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                             `json:"name"`
	JSON applicationRolloutNewResponseCurrentConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationRolloutNewResponseCurrentConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationRolloutNewResponseCurrentConfigurationEnvironmentVariable

type ApplicationRolloutNewResponseCurrentConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name string `json:"name" api:"required"`
	// An environment variable value.
	Value string                                                                   `json:"value" api:"required"`
	JSON  applicationRolloutNewResponseCurrentConfigurationEnvironmentVariableJSON `json:"-"`
}

An environment variable with a value set.

func (*ApplicationRolloutNewResponseCurrentConfigurationEnvironmentVariable) UnmarshalJSON

type ApplicationRolloutNewResponseCurrentConfigurationInstanceType

type ApplicationRolloutNewResponseCurrentConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationRolloutNewResponseCurrentConfigurationInstanceTypeLite      ApplicationRolloutNewResponseCurrentConfigurationInstanceType = "lite"
	ApplicationRolloutNewResponseCurrentConfigurationInstanceTypeBasic     ApplicationRolloutNewResponseCurrentConfigurationInstanceType = "basic"
	ApplicationRolloutNewResponseCurrentConfigurationInstanceTypeStandard1 ApplicationRolloutNewResponseCurrentConfigurationInstanceType = "standard-1"
	ApplicationRolloutNewResponseCurrentConfigurationInstanceTypeStandard2 ApplicationRolloutNewResponseCurrentConfigurationInstanceType = "standard-2"
	ApplicationRolloutNewResponseCurrentConfigurationInstanceTypeStandard3 ApplicationRolloutNewResponseCurrentConfigurationInstanceType = "standard-3"
	ApplicationRolloutNewResponseCurrentConfigurationInstanceTypeStandard4 ApplicationRolloutNewResponseCurrentConfigurationInstanceType = "standard-4"
)

func (ApplicationRolloutNewResponseCurrentConfigurationInstanceType) IsKnown

type ApplicationRolloutNewResponseCurrentConfigurationObservability

type ApplicationRolloutNewResponseCurrentConfigurationObservability struct {
	// Observability logging settings.
	Logs ApplicationRolloutNewResponseCurrentConfigurationObservabilityLogs `json:"logs"`
	JSON applicationRolloutNewResponseCurrentConfigurationObservabilityJSON `json:"-"`
}

Settings for deployment observability such as logging.

func (*ApplicationRolloutNewResponseCurrentConfigurationObservability) UnmarshalJSON

type ApplicationRolloutNewResponseCurrentConfigurationObservabilityLogs

type ApplicationRolloutNewResponseCurrentConfigurationObservabilityLogs struct {
	Enabled bool                                                                   `json:"enabled"`
	JSON    applicationRolloutNewResponseCurrentConfigurationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationRolloutNewResponseCurrentConfigurationObservabilityLogs) UnmarshalJSON

type ApplicationRolloutNewResponseEnvelope

type ApplicationRolloutNewResponseEnvelope struct {
	Errors   []ApplicationRolloutNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ApplicationRolloutNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Represents the status and metadata of a rollout process for an application. For
	// "rolling" strategy: includes steps and progress with instance counts. For
	// "new_instances" strategy: the response omits steps and progress. Use percentage,
	// version_distribution, and health.summary for status.
	Result ApplicationRolloutNewResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                                      `json:"success" api:"required"`
	JSON    applicationRolloutNewResponseEnvelopeJSON `json:"-"`
}

func (*ApplicationRolloutNewResponseEnvelope) UnmarshalJSON

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

type ApplicationRolloutNewResponseEnvelopeErrors

type ApplicationRolloutNewResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ApplicationRolloutNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             applicationRolloutNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ApplicationRolloutNewResponseEnvelopeErrors) UnmarshalJSON

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

type ApplicationRolloutNewResponseEnvelopeErrorsSource

type ApplicationRolloutNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    applicationRolloutNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ApplicationRolloutNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ApplicationRolloutNewResponseEnvelopeMessages

type ApplicationRolloutNewResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           ApplicationRolloutNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             applicationRolloutNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ApplicationRolloutNewResponseEnvelopeMessages) UnmarshalJSON

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

type ApplicationRolloutNewResponseEnvelopeMessagesSource

type ApplicationRolloutNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    applicationRolloutNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ApplicationRolloutNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ApplicationRolloutNewResponseHealth

type ApplicationRolloutNewResponseHealth struct {
	Errors []ApplicationRolloutNewResponseHealthError `json:"errors" api:"required"`
	// Shows a count of application instance states.
	Instances ApplicationRolloutNewResponseHealthInstances `json:"instances" api:"required"`
	// High-level health assessment. Only populated for "new_instances" strategy. Based
	// on a sample of target-version instances rather than a full count.
	//
	// - "pending": Zero target-version instances exist yet.
	// - "healthy": Every sampled target-version instance reports running or active.
	// - "degraded": Some sampled instances remain starting or scheduling.
	// - "unhealthy": One or more sampled instances have failed.
	Summary ApplicationRolloutNewResponseHealthSummary `json:"summary"`
	JSON    applicationRolloutNewResponseHealthJSON    `json:"-"`
}

func (*ApplicationRolloutNewResponseHealth) UnmarshalJSON

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

type ApplicationRolloutNewResponseHealthError

type ApplicationRolloutNewResponseHealthError struct {
	// An event within a Placement or a Job.
	Event ApplicationRolloutNewResponseHealthErrorsEvent `json:"event" api:"required"`
	// An instance ID represents an identifier of an instance configuration that
	// maintains an underlying placement.
	InstanceID string                                       `json:"instance_id" api:"required"`
	JSON       applicationRolloutNewResponseHealthErrorJSON `json:"-"`
}

func (*ApplicationRolloutNewResponseHealthError) UnmarshalJSON

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

type ApplicationRolloutNewResponseHealthErrorsEvent

type ApplicationRolloutNewResponseHealthErrorsEvent struct {
	ID      string                 `json:"id" api:"required"`
	Details map[string]interface{} `json:"details" api:"required"`
	Message string                 `json:"message" api:"required"`
	// Name of the event that describes the kind event that happened.
	//
	//   - SchedulerPlaced: It's the first event that creates a container placement. It
	//     happens when the Containers runtime was able to retrieve deployment resources
	//     and start verifying everything is correct.
	//   - NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the
	//     container.
	//   - VMStarted: It's sent when the Containers runtime starts the VM. The container
	//     might remain unhealthy at this point.
	//   - ImagePulled: It's sent when the Containers runtime pulls the image
	//     successfully.
	//   - ImagePullError: It's sent when the Containers runtime is having issues pulling
	//     the image. The message and details have more information on what happened for
	//     debugging.
	//   - VMFailedToStart: It's sent when the Containers runtime was unable to boot the
	//     VM.
	//   - VMStopping: It's sent when the scheduler is stopping the VM.
	//   - VMStopped: It's sent when the VM finally exits.
	//   - VMFailed: It's sent when the scheduling of the VM failed in the current
	//     location.
	//   - RuntimeStartFailed: It's sent when the runtime hits an internal error.
	//   - SSHStarted: It's sent when the container gains network connectivity and opens
	//     the SSH port. Containers only send this event when SSH keys exist.
	//   - CheckUpdate: Sent when the status of a health or readiness check changes. This
	//     may also affect the health status of the placement.
	//   - DurableObjectConnected: Sent when a durable object instance connects and gains
	//     control of the deployment. This event is only sent for durable object
	//     deployments. It is sent after VMStarted.
	//   - ContainerStarted: It's sent when the container starts running.
	Name         ApplicationRolloutNewResponseHealthErrorsEventName `json:"name" api:"required"`
	StatusChange map[string]interface{}                             `json:"statusChange" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	Time string                                             `json:"time" api:"required"`
	Type ApplicationRolloutNewResponseHealthErrorsEventType `json:"type" api:"required"`
	JSON applicationRolloutNewResponseHealthErrorsEventJSON `json:"-"`
}

An event within a Placement or a Job.

func (*ApplicationRolloutNewResponseHealthErrorsEvent) UnmarshalJSON

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

type ApplicationRolloutNewResponseHealthErrorsEventName

type ApplicationRolloutNewResponseHealthErrorsEventName string

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It's the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It's sent when the Containers runtime maps the IP to the container.
  • VMStarted: It's sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It's sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It's sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It's sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It's sent when the scheduler is stopping the VM.
  • VMStopped: It's sent when the VM finally exits.
  • VMFailed: It's sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It's sent when the runtime hits an internal error.
  • SSHStarted: It's sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It's sent when the container starts running.
const (
	ApplicationRolloutNewResponseHealthErrorsEventNameSchedulerPlaced              ApplicationRolloutNewResponseHealthErrorsEventName = "SchedulerPlaced"
	ApplicationRolloutNewResponseHealthErrorsEventNameNetworkingIPAssigned         ApplicationRolloutNewResponseHealthErrorsEventName = "NetworkingIPAssigned"
	ApplicationRolloutNewResponseHealthErrorsEventNameVmStarted                    ApplicationRolloutNewResponseHealthErrorsEventName = "VMStarted"
	ApplicationRolloutNewResponseHealthErrorsEventNameImagePulled                  ApplicationRolloutNewResponseHealthErrorsEventName = "ImagePulled"
	ApplicationRolloutNewResponseHealthErrorsEventNameImagePullError               ApplicationRolloutNewResponseHealthErrorsEventName = "ImagePullError"
	ApplicationRolloutNewResponseHealthErrorsEventNameVmFailedToStart              ApplicationRolloutNewResponseHealthErrorsEventName = "VMFailedToStart"
	ApplicationRolloutNewResponseHealthErrorsEventNameNetworkingIPAssignmentFailed ApplicationRolloutNewResponseHealthErrorsEventName = "NetworkingIPAssignmentFailed"
	ApplicationRolloutNewResponseHealthErrorsEventNameVmRunning                    ApplicationRolloutNewResponseHealthErrorsEventName = "VMRunning"
	ApplicationRolloutNewResponseHealthErrorsEventNameVmStopping                   ApplicationRolloutNewResponseHealthErrorsEventName = "VMStopping"
	ApplicationRolloutNewResponseHealthErrorsEventNameVmStopped                    ApplicationRolloutNewResponseHealthErrorsEventName = "VMStopped"
	ApplicationRolloutNewResponseHealthErrorsEventNameVmFailed                     ApplicationRolloutNewResponseHealthErrorsEventName = "VMFailed"
	ApplicationRolloutNewResponseHealthErrorsEventNameRuntimeStartFailed           ApplicationRolloutNewResponseHealthErrorsEventName = "RuntimeStartFailed"
	ApplicationRolloutNewResponseHealthErrorsEventNameSSHStarted                   ApplicationRolloutNewResponseHealthErrorsEventName = "SSHStarted"
	ApplicationRolloutNewResponseHealthErrorsEventNameServiceHealthUpdates         ApplicationRolloutNewResponseHealthErrorsEventName = "ServiceHealthUpdates"
	ApplicationRolloutNewResponseHealthErrorsEventNameCheckUpdate                  ApplicationRolloutNewResponseHealthErrorsEventName = "CheckUpdate"
	ApplicationRolloutNewResponseHealthErrorsEventNameDurableObjectConnected       ApplicationRolloutNewResponseHealthErrorsEventName = "DurableObjectConnected"
	ApplicationRolloutNewResponseHealthErrorsEventNameContainerStarted             ApplicationRolloutNewResponseHealthErrorsEventName = "ContainerStarted"
)

func (ApplicationRolloutNewResponseHealthErrorsEventName) IsKnown

type ApplicationRolloutNewResponseHealthErrorsEventType

type ApplicationRolloutNewResponseHealthErrorsEventType string
const (
	ApplicationRolloutNewResponseHealthErrorsEventTypeInfo        ApplicationRolloutNewResponseHealthErrorsEventType = "Info"
	ApplicationRolloutNewResponseHealthErrorsEventTypeError       ApplicationRolloutNewResponseHealthErrorsEventType = "Error"
	ApplicationRolloutNewResponseHealthErrorsEventTypeWarn        ApplicationRolloutNewResponseHealthErrorsEventType = "Warn"
	ApplicationRolloutNewResponseHealthErrorsEventTypeUserError   ApplicationRolloutNewResponseHealthErrorsEventType = "UserError"
	ApplicationRolloutNewResponseHealthErrorsEventTypeSystemError ApplicationRolloutNewResponseHealthErrorsEventType = "SystemError"
)

func (ApplicationRolloutNewResponseHealthErrorsEventType) IsKnown

type ApplicationRolloutNewResponseHealthInstances

type ApplicationRolloutNewResponseHealthInstances struct {
	// Number of instances whose runtime reports the container as running
	// (container_status = "running"). This is a subset of the placements that remain
	// up: an instance that is already bound to a Durable Object and serving traffic is
	// counted under "assigned" until its container_status catches up to "running", so
	// container_status can briefly lag Durable Object attachment under churn. To
	// estimate running, Durable-Object-bound instances, sum "active" + "assigned"
	// rather than reading "active" alone.
	Active int64 `json:"active" api:"required"`
	// Number of instances bound to a Durable Object with a running placement whose
	// container_status remains behind "running". These count as live, serving
	// instances; "active" + "assigned" approximates the running, Durable-Object-bound
	// count.
	Assigned int64                                            `json:"assigned" api:"required"`
	JSON     applicationRolloutNewResponseHealthInstancesJSON `json:"-"`
}

Shows a count of application instance states.

func (*ApplicationRolloutNewResponseHealthInstances) UnmarshalJSON

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

type ApplicationRolloutNewResponseHealthSummary

type ApplicationRolloutNewResponseHealthSummary string

High-level health assessment. Only populated for "new_instances" strategy. Based on a sample of target-version instances rather than a full count.

- "pending": Zero target-version instances exist yet. - "healthy": Every sampled target-version instance reports running or active. - "degraded": Some sampled instances remain starting or scheduling. - "unhealthy": One or more sampled instances have failed.

const (
	ApplicationRolloutNewResponseHealthSummaryHealthy   ApplicationRolloutNewResponseHealthSummary = "healthy"
	ApplicationRolloutNewResponseHealthSummaryDegraded  ApplicationRolloutNewResponseHealthSummary = "degraded"
	ApplicationRolloutNewResponseHealthSummaryUnhealthy ApplicationRolloutNewResponseHealthSummary = "unhealthy"
	ApplicationRolloutNewResponseHealthSummaryPending   ApplicationRolloutNewResponseHealthSummary = "pending"
)

func (ApplicationRolloutNewResponseHealthSummary) IsKnown

type ApplicationRolloutNewResponseKind

type ApplicationRolloutNewResponseKind string

Kind of the rollout process.

  • "full_auto": For rolling rollouts, starts progressing steps upon rollout creation. For new_instances rollouts, advances percentage targets automatically after target-version health is observed.
  • "full_manual": Requires manually progressing each step in the rollout using the UpdateRollout's action paramater.
  • "durable_objects_auto": Default when the application is a DO application.
const (
	ApplicationRolloutNewResponseKindFullAuto           ApplicationRolloutNewResponseKind = "full_auto"
	ApplicationRolloutNewResponseKindFullManual         ApplicationRolloutNewResponseKind = "full_manual"
	ApplicationRolloutNewResponseKindDurableObjectsAuto ApplicationRolloutNewResponseKind = "durable_objects_auto"
)

func (ApplicationRolloutNewResponseKind) IsKnown

type ApplicationRolloutNewResponseProgress

type ApplicationRolloutNewResponseProgress struct {
	// Current step being executed in the rollout process. Initialized to 0.
	CurrentStep int64 `json:"current_step" api:"required"`
	// Total number of instances the rollout affects.
	TotalInstances int64 `json:"total_instances" api:"required"`
	// Total number of steps in the rollout.
	TotalSteps int64 `json:"total_steps" api:"required"`
	// Number of instances updated in the rollout process.
	UpdatedInstances int64 `json:"updated_instances" api:"required"`
	// Expected distribution of instances per version, based on the current percentage
	// split. Populated during active rollouts. Values derive from the version
	// percentage weights rather than actual running instance counts.
	VersionDistribution ApplicationRolloutNewResponseProgressVersionDistribution `json:"version_distribution"`
	JSON                applicationRolloutNewResponseProgressJSON                `json:"-"`
}

Progress details of an application rollout.

func (*ApplicationRolloutNewResponseProgress) UnmarshalJSON

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

type ApplicationRolloutNewResponseProgressVersionDistribution

type ApplicationRolloutNewResponseProgressVersionDistribution struct {
	// Expected number of instances remaining on the current (old) version based on the
	// current percentage split. Only populated for "rolling" strategy.
	CurrentVersionInstances int64 `json:"current_version_instances"`
	// The percentage of new instances being scheduled on the current version (100 -
	// target_version_percentage). Only populated for "new_instances" strategy.
	CurrentVersionPercentage int64 `json:"current_version_percentage"`
	// Expected number of instances scheduled for the target (new) version based on the
	// current percentage split. Only populated for "rolling" strategy.
	TargetVersionInstances int64 `json:"target_version_instances"`
	// The active percentage of new instances being scheduled on the target version.
	// For "rolling", this reflects the step_size.percentage of the current active
	// step. For "new_instances", this reflects the user-set percentage.
	TargetVersionPercentage int64                                                        `json:"target_version_percentage"`
	JSON                    applicationRolloutNewResponseProgressVersionDistributionJSON `json:"-"`
}

Expected distribution of instances per version, based on the current percentage split. Populated during active rollouts. Values derive from the version percentage weights rather than actual running instance counts.

func (*ApplicationRolloutNewResponseProgressVersionDistribution) UnmarshalJSON

type ApplicationRolloutNewResponseStatus

type ApplicationRolloutNewResponseStatus string

Current status of the rollout.

const (
	ApplicationRolloutNewResponseStatusPending     ApplicationRolloutNewResponseStatus = "pending"
	ApplicationRolloutNewResponseStatusProgressing ApplicationRolloutNewResponseStatus = "progressing"
	ApplicationRolloutNewResponseStatusCompleted   ApplicationRolloutNewResponseStatus = "completed"
	ApplicationRolloutNewResponseStatusReverted    ApplicationRolloutNewResponseStatus = "reverted"
	ApplicationRolloutNewResponseStatusReplaced    ApplicationRolloutNewResponseStatus = "replaced"
)

func (ApplicationRolloutNewResponseStatus) IsKnown

type ApplicationRolloutNewResponseStep

type ApplicationRolloutNewResponseStep struct {
	// The sequential order of the rollout step, automatically assigned starting from
	// 1, based on the total number of steps in the rollout process.
	ID int64 `json:"id" api:"required"`
	// Description of the rollout step.
	Description string `json:"description" api:"required"`
	// Status of the rollout step.
	Status   ApplicationRolloutNewResponseStepsStatus   `json:"status" api:"required"`
	StepSize ApplicationRolloutNewResponseStepsStepSize `json:"step_size" api:"required"`
	// UTC timestamp string in ISO 8601 format.
	CompletedAt string `json:"completed_at"`
	// Reason for the step's current status.
	Reason string `json:"reason"`
	// UTC timestamp string in ISO 8601 format.
	StartedAt string                                `json:"started_at"`
	JSON      applicationRolloutNewResponseStepJSON `json:"-"`
}

Steps within the rollout process.

func (*ApplicationRolloutNewResponseStep) UnmarshalJSON

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

type ApplicationRolloutNewResponseStepsStatus

type ApplicationRolloutNewResponseStepsStatus string

Status of the rollout step.

const (
	ApplicationRolloutNewResponseStepsStatusPending     ApplicationRolloutNewResponseStepsStatus = "pending"
	ApplicationRolloutNewResponseStepsStatusProgressing ApplicationRolloutNewResponseStepsStatus = "progressing"
	ApplicationRolloutNewResponseStepsStatusReverting   ApplicationRolloutNewResponseStepsStatus = "reverting"
	ApplicationRolloutNewResponseStepsStatusCompleted   ApplicationRolloutNewResponseStepsStatus = "completed"
	ApplicationRolloutNewResponseStepsStatusReverted    ApplicationRolloutNewResponseStepsStatus = "reverted"
)

func (ApplicationRolloutNewResponseStepsStatus) IsKnown

type ApplicationRolloutNewResponseStepsStepSize

type ApplicationRolloutNewResponseStepsStepSize struct {
	// Percentage of instances affected in this step. Min 10% and Max 100%.
	Percentage int64                                          `json:"percentage" api:"required"`
	JSON       applicationRolloutNewResponseStepsStepSizeJSON `json:"-"`
}

func (*ApplicationRolloutNewResponseStepsStepSize) UnmarshalJSON

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

type ApplicationRolloutNewResponseStrategy

type ApplicationRolloutNewResponseStrategy string

The rollout strategy.

  • "rolling": Step-based rollout with health gates. Actively replaces instances to reach each step's target percentage. Response includes steps and progress.
  • "new_instances": Percentage control over version distribution. Version sync actively replaces instances to match the configured percentage. "full_auto" ramps through fixed percentage targets after target-version health is observed. Response includes percentage, version_distribution, and health.summary.
const (
	ApplicationRolloutNewResponseStrategyRolling      ApplicationRolloutNewResponseStrategy = "rolling"
	ApplicationRolloutNewResponseStrategyNewInstances ApplicationRolloutNewResponseStrategy = "new_instances"
)

func (ApplicationRolloutNewResponseStrategy) IsKnown

type ApplicationRolloutNewResponseTargetConfiguration

type ApplicationRolloutNewResponseTargetConfiguration struct {
	AuthorizedKeys []ApplicationRolloutNewResponseTargetConfigurationAuthorizedKey `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command []string `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint []string `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables []ApplicationRolloutNewResponseTargetConfigurationEnvironmentVariable `json:"environment_variables"`
	// Image url.
	Image string `json:"image"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType ApplicationRolloutNewResponseTargetConfigurationInstanceType `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability ApplicationRolloutNewResponseTargetConfigurationObservability `json:"observability"`
	JSON          applicationRolloutNewResponseTargetConfigurationJSON          `json:"-"`
}

User-specified container configuration changes.

func (*ApplicationRolloutNewResponseTargetConfiguration) UnmarshalJSON

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

type ApplicationRolloutNewResponseTargetConfigurationAuthorizedKey

type ApplicationRolloutNewResponseTargetConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                            `json:"name"`
	JSON applicationRolloutNewResponseTargetConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationRolloutNewResponseTargetConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationRolloutNewResponseTargetConfigurationEnvironmentVariable

type ApplicationRolloutNewResponseTargetConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name string `json:"name" api:"required"`
	// An environment variable value.
	Value string                                                                  `json:"value" api:"required"`
	JSON  applicationRolloutNewResponseTargetConfigurationEnvironmentVariableJSON `json:"-"`
}

An environment variable with a value set.

func (*ApplicationRolloutNewResponseTargetConfigurationEnvironmentVariable) UnmarshalJSON

type ApplicationRolloutNewResponseTargetConfigurationInstanceType

type ApplicationRolloutNewResponseTargetConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationRolloutNewResponseTargetConfigurationInstanceTypeLite      ApplicationRolloutNewResponseTargetConfigurationInstanceType = "lite"
	ApplicationRolloutNewResponseTargetConfigurationInstanceTypeBasic     ApplicationRolloutNewResponseTargetConfigurationInstanceType = "basic"
	ApplicationRolloutNewResponseTargetConfigurationInstanceTypeStandard1 ApplicationRolloutNewResponseTargetConfigurationInstanceType = "standard-1"
	ApplicationRolloutNewResponseTargetConfigurationInstanceTypeStandard2 ApplicationRolloutNewResponseTargetConfigurationInstanceType = "standard-2"
	ApplicationRolloutNewResponseTargetConfigurationInstanceTypeStandard3 ApplicationRolloutNewResponseTargetConfigurationInstanceType = "standard-3"
	ApplicationRolloutNewResponseTargetConfigurationInstanceTypeStandard4 ApplicationRolloutNewResponseTargetConfigurationInstanceType = "standard-4"
)

func (ApplicationRolloutNewResponseTargetConfigurationInstanceType) IsKnown

type ApplicationRolloutNewResponseTargetConfigurationObservability

type ApplicationRolloutNewResponseTargetConfigurationObservability struct {
	// Observability logging settings.
	Logs ApplicationRolloutNewResponseTargetConfigurationObservabilityLogs `json:"logs"`
	JSON applicationRolloutNewResponseTargetConfigurationObservabilityJSON `json:"-"`
}

Settings for deployment observability such as logging.

func (*ApplicationRolloutNewResponseTargetConfigurationObservability) UnmarshalJSON

type ApplicationRolloutNewResponseTargetConfigurationObservabilityLogs

type ApplicationRolloutNewResponseTargetConfigurationObservabilityLogs struct {
	Enabled bool                                                                  `json:"enabled"`
	JSON    applicationRolloutNewResponseTargetConfigurationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationRolloutNewResponseTargetConfigurationObservabilityLogs) UnmarshalJSON

type ApplicationRolloutNewResponseVersionDistribution

type ApplicationRolloutNewResponseVersionDistribution struct {
	// Percentage of instances on the current (old) version.
	CurrentVersionPercentage int64 `json:"current_version_percentage" api:"required"`
	// Percentage of instances on the target (new) version.
	TargetVersionPercentage int64                                                `json:"target_version_percentage" api:"required"`
	JSON                    applicationRolloutNewResponseVersionDistributionJSON `json:"-"`
}

Version percentage distribution. Only present for "new_instances" strategy. For "rolling" strategy, see progress.version_distribution instead.

func (*ApplicationRolloutNewResponseVersionDistribution) UnmarshalJSON

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

type ApplicationRolloutService

type ApplicationRolloutService struct {
	Options []option.RequestOption
}

ApplicationRolloutService 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 NewApplicationRolloutService method instead.

func NewApplicationRolloutService

func NewApplicationRolloutService(opts ...option.RequestOption) (r *ApplicationRolloutService)

NewApplicationRolloutService 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 (*ApplicationRolloutService) New

Creates a rollout to update the application's configuration across instances with minimal downtime. Rollouts apply only to scheduler-backed applications with `scheduling_policy: "default"`. Versions and rollouts do not apply to applications with `scheduling_policy: "durable_object"`.

type ApplicationService

type ApplicationService struct {
	Options   []option.RequestOption
	Instances *ApplicationInstanceService
	Rollouts  *ApplicationRolloutService
	Versions  *ApplicationVersionService
}

ApplicationService 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 NewApplicationService method instead.

func NewApplicationService

func NewApplicationService(opts ...option.RequestOption) (r *ApplicationService)

NewApplicationService 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 (*ApplicationService) Delete

func (r *ApplicationService) Delete(ctx context.Context, applicationID string, body ApplicationDeleteParams, opts ...option.RequestOption) (res *ApplicationDeleteResponse, err error)

Deletes a single application by id.

func (*ApplicationService) Edit

func (r *ApplicationService) Edit(ctx context.Context, applicationID string, params ApplicationEditParams, opts ...option.RequestOption) (res *ApplicationEditResponse, err error)

Modifies a single application by id. Durable Object-managed application settings are published to runtime metadata without creating deployments or rollouts. Top-level `observability` for these applications supports only `logs.enabled`. The supported fields depend on the existing application's scheduling policy. For scheduler-backed applications, changes that replace instance deployment configuration, including the image, require a rollout.

func (*ApplicationService) Get

func (r *ApplicationService) Get(ctx context.Context, applicationID string, query ApplicationGetParams, opts ...option.RequestOption) (res *ApplicationGetResponse, err error)

Returns a single application by id.

func (*ApplicationService) List

Lists all the applications that are associated with your account.

func (*ApplicationService) ListAutoPaging

Lists all the applications that are associated with your account.

func (*ApplicationService) New

Create a Containers application.

Use `scheduling_policy: "default"` for a scheduler-backed application. The Containers scheduler maintains the requested instance count and manages deployment configuration, placement, scaling, versions, and rollouts.

Use `scheduling_policy: "durable_object"` for a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Supply `name`, `scheduling_policy`, and `durable_objects`, with optional `configuration` and optional top-level `observability` settings. Deployment configuration, scaling, constraints, versions, and rollouts do not apply.

type ApplicationVersionListParams

type ApplicationVersionListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ApplicationVersionListResponse

type ApplicationVersionListResponse struct {
	// User-specified container configuration changes.
	Configuration ApplicationVersionListResponseConfiguration `json:"configuration" api:"required"`
	Percentage    int64                                       `json:"percentage" api:"required"`
	Version       int64                                       `json:"version" api:"required"`
	JSON          applicationVersionListResponseJSON          `json:"-"`
}

An application with the configuration of its version.

func (*ApplicationVersionListResponse) UnmarshalJSON

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

type ApplicationVersionListResponseConfiguration

type ApplicationVersionListResponseConfiguration struct {
	AuthorizedKeys []ApplicationVersionListResponseConfigurationAuthorizedKey `json:"authorized_keys"`
	// The command that runs when the container starts, passed to the entrypoint. You
	// can override this at run-time. If you override only the command, it gets passed
	// to the default entrypoint specified in the image.
	Command []string `json:"command"`
	// The entry point for the container, specifying the executable to run when the
	// container starts. You can override this at run-time. If you do, the default
	// command from the image is ignored. Specify both entrypoint and command at
	// run-time to completely replace the image defaults.
	Entrypoint []string `json:"entrypoint"`
	// Container environment variables.
	EnvironmentVariables []ApplicationVersionListResponseConfigurationEnvironmentVariable `json:"environment_variables"`
	// Image url.
	Image string `json:"image"`
	// The instance type configures vCPU, memory, and disk.
	//
	// - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
	// - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
	// - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
	// - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
	// - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
	// - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
	InstanceType ApplicationVersionListResponseConfigurationInstanceType `json:"instance_type"`
	// Settings for deployment observability such as logging.
	Observability ApplicationVersionListResponseConfigurationObservability `json:"observability"`
	JSON          applicationVersionListResponseConfigurationJSON          `json:"-"`
}

User-specified container configuration changes.

func (*ApplicationVersionListResponseConfiguration) UnmarshalJSON

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

type ApplicationVersionListResponseConfigurationAuthorizedKey

type ApplicationVersionListResponseConfigurationAuthorizedKey struct {
	// An SSH public key.
	PublicKey string `json:"public_key" api:"required"`
	// Optional human readable name for this key.
	Name string                                                       `json:"name"`
	JSON applicationVersionListResponseConfigurationAuthorizedKeyJSON `json:"-"`
}

User-provided SSH public key.

func (*ApplicationVersionListResponseConfigurationAuthorizedKey) UnmarshalJSON

type ApplicationVersionListResponseConfigurationEnvironmentVariable

type ApplicationVersionListResponseConfigurationEnvironmentVariable struct {
	// An environment variable name.
	Name string `json:"name" api:"required"`
	// An environment variable value.
	Value string                                                             `json:"value" api:"required"`
	JSON  applicationVersionListResponseConfigurationEnvironmentVariableJSON `json:"-"`
}

An environment variable with a value set.

func (*ApplicationVersionListResponseConfigurationEnvironmentVariable) UnmarshalJSON

type ApplicationVersionListResponseConfigurationInstanceType

type ApplicationVersionListResponseConfigurationInstanceType string

The instance type configures vCPU, memory, and disk.

- "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk

const (
	ApplicationVersionListResponseConfigurationInstanceTypeLite      ApplicationVersionListResponseConfigurationInstanceType = "lite"
	ApplicationVersionListResponseConfigurationInstanceTypeBasic     ApplicationVersionListResponseConfigurationInstanceType = "basic"
	ApplicationVersionListResponseConfigurationInstanceTypeStandard1 ApplicationVersionListResponseConfigurationInstanceType = "standard-1"
	ApplicationVersionListResponseConfigurationInstanceTypeStandard2 ApplicationVersionListResponseConfigurationInstanceType = "standard-2"
	ApplicationVersionListResponseConfigurationInstanceTypeStandard3 ApplicationVersionListResponseConfigurationInstanceType = "standard-3"
	ApplicationVersionListResponseConfigurationInstanceTypeStandard4 ApplicationVersionListResponseConfigurationInstanceType = "standard-4"
)

func (ApplicationVersionListResponseConfigurationInstanceType) IsKnown

type ApplicationVersionListResponseConfigurationObservability

type ApplicationVersionListResponseConfigurationObservability struct {
	// Observability logging settings.
	Logs ApplicationVersionListResponseConfigurationObservabilityLogs `json:"logs"`
	JSON applicationVersionListResponseConfigurationObservabilityJSON `json:"-"`
}

Settings for deployment observability such as logging.

func (*ApplicationVersionListResponseConfigurationObservability) UnmarshalJSON

type ApplicationVersionListResponseConfigurationObservabilityLogs

type ApplicationVersionListResponseConfigurationObservabilityLogs struct {
	Enabled bool                                                             `json:"enabled"`
	JSON    applicationVersionListResponseConfigurationObservabilityLogsJSON `json:"-"`
}

Observability logging settings.

func (*ApplicationVersionListResponseConfigurationObservabilityLogs) UnmarshalJSON

type ApplicationVersionService

type ApplicationVersionService struct {
	Options []option.RequestOption
}

ApplicationVersionService 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 NewApplicationVersionService method instead.

func NewApplicationVersionService

func NewApplicationVersionService(opts ...option.RequestOption) (r *ApplicationVersionService)

NewApplicationVersionService 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 (*ApplicationVersionService) List

Returns all versions for a scheduler-backed application with `scheduling_policy: "default"`. Versions and rollouts do not apply to applications with `scheduling_policy: "durable_object"`.

func (*ApplicationVersionService) ListAutoPaging

Returns all versions for a scheduler-backed application with `scheduling_policy: "default"`. Versions and rollouts do not apply to applications with `scheduling_policy: "durable_object"`.

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 ContainerService

type ContainerService struct {
	Options      []option.RequestOption
	Applications *ApplicationService
	Images       *ImageService
	Registries   *RegistryService
}

ContainerService 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 NewContainerService method instead.

func NewContainerService

func NewContainerService(opts ...option.RequestOption) (r *ContainerService)

NewContainerService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

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

type ImagePrepareParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Image url.
	Image param.Field[string] `json:"image" api:"required"`
}

func (ImagePrepareParams) MarshalJSON

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

type ImagePrepareResponse

type ImagePrepareResponse struct {
	// Image url.
	Image string `json:"image" api:"required"`
	// Current durable preparation state for a container image.
	Status ImagePrepareResponseStatus `json:"status" api:"required"`
	// Digest of the prepared runtime artifact when status is ready.
	ArtifactDigest string `json:"artifact_digest"`
	// Human-readable pending or terminal error detail.
	Reason string                   `json:"reason"`
	JSON   imagePrepareResponseJSON `json:"-"`
}

Durable preparation state for a container image.

func (*ImagePrepareResponse) UnmarshalJSON

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

type ImagePrepareResponseEnvelope

type ImagePrepareResponseEnvelope struct {
	Errors   []ImagePrepareResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ImagePrepareResponseEnvelopeMessages `json:"messages" api:"required"`
	// Durable preparation state for a container image.
	Result ImagePrepareResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                             `json:"success" api:"required"`
	JSON    imagePrepareResponseEnvelopeJSON `json:"-"`
}

func (*ImagePrepareResponseEnvelope) UnmarshalJSON

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

type ImagePrepareResponseEnvelopeErrors

type ImagePrepareResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           ImagePrepareResponseEnvelopeErrorsSource `json:"source"`
	JSON             imagePrepareResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ImagePrepareResponseEnvelopeErrors) UnmarshalJSON

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

type ImagePrepareResponseEnvelopeErrorsSource

type ImagePrepareResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    imagePrepareResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ImagePrepareResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ImagePrepareResponseEnvelopeMessages

type ImagePrepareResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ImagePrepareResponseEnvelopeMessagesSource `json:"source"`
	JSON             imagePrepareResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ImagePrepareResponseEnvelopeMessages) UnmarshalJSON

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

type ImagePrepareResponseEnvelopeMessagesSource

type ImagePrepareResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    imagePrepareResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ImagePrepareResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ImagePrepareResponseStatus

type ImagePrepareResponseStatus string

Current durable preparation state for a container image.

const (
	ImagePrepareResponseStatusPending ImagePrepareResponseStatus = "pending"
	ImagePrepareResponseStatusReady   ImagePrepareResponseStatus = "ready"
	ImagePrepareResponseStatusError   ImagePrepareResponseStatus = "error"
)

func (ImagePrepareResponseStatus) IsKnown

func (r ImagePrepareResponseStatus) IsKnown() bool

type ImageService

type ImageService struct {
	Options []option.RequestOption
}

ImageService 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 NewImageService method instead.

func NewImageService

func NewImageService(opts ...option.RequestOption) (r *ImageService)

NewImageService 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 (*ImageService) Prepare

func (r *ImageService) Prepare(ctx context.Context, params ImagePrepareParams, opts ...option.RequestOption) (res *ImagePrepareResponse, err error)

Idempotently starts or observes preparation of the runtime artifacts required to run one digest-pinned managed container image on Cloudflare's network. Returns 202 while durable preparation continues and 200 when the image is ready or preparation has reached a terminal error.

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 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 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 RegistryCredentialGenerateParams

type RegistryCredentialGenerateParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The number of minutes Cloudflare managed registry credentials stay valid.
	// Required for managed registries and must remain positive. Cloudflare ignores
	// this value for external registries.
	ExpirationMinutes param.Field[int64] `json:"expiration_minutes"`
	// The permissions for Cloudflare managed registry credentials. Required for
	// managed registries. Cloudflare ignores this value for external registries.
	Permissions param.Field[[]RegistryCredentialGenerateParamsPermission] `json:"permissions"`
}

func (RegistryCredentialGenerateParams) MarshalJSON

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

type RegistryCredentialGenerateParamsPermission

type RegistryCredentialGenerateParamsPermission string

Specifies what permissions the credentials carry.

const (
	RegistryCredentialGenerateParamsPermissionPull RegistryCredentialGenerateParamsPermission = "pull"
	RegistryCredentialGenerateParamsPermissionPush RegistryCredentialGenerateParamsPermission = "push"
	RegistryCredentialGenerateParamsPermissionList RegistryCredentialGenerateParamsPermission = "list"
)

func (RegistryCredentialGenerateParamsPermission) IsKnown

type RegistryCredentialGenerateResponse

type RegistryCredentialGenerateResponse struct {
	// A unique identifier for the user's account.
	AccountID string `json:"account_id" api:"required"`
	// The password to use when authenticating to the image registry.
	Password string `json:"password" api:"required"`
	// The domain of the image registry these credentials target.
	RegistryHost string `json:"registry_host" api:"required"`
	// The username to use when authenticating to the image registry.
	Username string                                 `json:"username" api:"required"`
	JSON     registryCredentialGenerateResponseJSON `json:"-"`
}

Credentials returned for an authenticated registry configured on a Containers account.

func (*RegistryCredentialGenerateResponse) UnmarshalJSON

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

type RegistryCredentialGenerateResponseEnvelope

type RegistryCredentialGenerateResponseEnvelope struct {
	Errors   []RegistryCredentialGenerateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RegistryCredentialGenerateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Credentials returned for an authenticated registry configured on a Containers
	// account.
	Result RegistryCredentialGenerateResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                                           `json:"success" api:"required"`
	JSON    registryCredentialGenerateResponseEnvelopeJSON `json:"-"`
}

func (*RegistryCredentialGenerateResponseEnvelope) UnmarshalJSON

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

type RegistryCredentialGenerateResponseEnvelopeErrors

type RegistryCredentialGenerateResponseEnvelopeErrors struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           RegistryCredentialGenerateResponseEnvelopeErrorsSource `json:"source"`
	JSON             registryCredentialGenerateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RegistryCredentialGenerateResponseEnvelopeErrors) UnmarshalJSON

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

type RegistryCredentialGenerateResponseEnvelopeErrorsSource

type RegistryCredentialGenerateResponseEnvelopeErrorsSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    registryCredentialGenerateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RegistryCredentialGenerateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type RegistryCredentialGenerateResponseEnvelopeMessages

type RegistryCredentialGenerateResponseEnvelopeMessages struct {
	Code             int64                                                    `json:"code" api:"required"`
	Message          string                                                   `json:"message" api:"required"`
	DocumentationURL string                                                   `json:"documentation_url"`
	Source           RegistryCredentialGenerateResponseEnvelopeMessagesSource `json:"source"`
	JSON             registryCredentialGenerateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RegistryCredentialGenerateResponseEnvelopeMessages) UnmarshalJSON

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

type RegistryCredentialGenerateResponseEnvelopeMessagesSource

type RegistryCredentialGenerateResponseEnvelopeMessagesSource struct {
	Pointer string                                                       `json:"pointer"`
	JSON    registryCredentialGenerateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RegistryCredentialGenerateResponseEnvelopeMessagesSource) UnmarshalJSON

type RegistryCredentialService

type RegistryCredentialService struct {
	Options []option.RequestOption
}

RegistryCredentialService 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 NewRegistryCredentialService method instead.

func NewRegistryCredentialService

func NewRegistryCredentialService(opts ...option.RequestOption) (r *RegistryCredentialService)

NewRegistryCredentialService 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 (*RegistryCredentialService) Generate

Generates credentials for accessing a configured container image registry.

type RegistryDeleteParams

type RegistryDeleteParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type RegistryDeleteResponse

type RegistryDeleteResponse struct {
	// A string representation of a domain name. See RFC-1034
	// (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name
	// is min 3 and max 253 ASCII characters.
	Domain string                     `json:"domain" api:"required"`
	JSON   registryDeleteResponseJSON `json:"-"`
}

Result of deleting an image registry from a Containers account.

func (*RegistryDeleteResponse) UnmarshalJSON

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

type RegistryDeleteResponseEnvelope

type RegistryDeleteResponseEnvelope struct {
	Errors   []RegistryDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RegistryDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Result of deleting an image registry from a Containers account.
	Result RegistryDeleteResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                               `json:"success" api:"required"`
	JSON    registryDeleteResponseEnvelopeJSON `json:"-"`
}

func (*RegistryDeleteResponseEnvelope) UnmarshalJSON

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

type RegistryDeleteResponseEnvelopeErrors

type RegistryDeleteResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           RegistryDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             registryDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RegistryDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type RegistryDeleteResponseEnvelopeErrorsSource

type RegistryDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    registryDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RegistryDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

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

type RegistryDeleteResponseEnvelopeMessages

type RegistryDeleteResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           RegistryDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             registryDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RegistryDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type RegistryDeleteResponseEnvelopeMessagesSource

type RegistryDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    registryDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RegistryDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

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

type RegistryListParams

type RegistryListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type RegistryListResponse

type RegistryListResponse struct {
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// A string representation of a domain name. See RFC-1034
	// (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name
	// is min 3 and max 253 ASCII characters.
	Domain string `json:"domain" api:"required"`
	// The type of registry that is being configured.
	Kind RegistryListResponseKind `json:"kind"`
	// Public component of the registry credentials. For managed registries this is a
	// base64-encoded public key; for external registries the format depends on the
	// registry provider.
	PublicKey string                   `json:"public_key"`
	JSON      registryListResponseJSON `json:"-"`
}

An image registry added in a customer account.

func (*RegistryListResponse) UnmarshalJSON

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

type RegistryListResponseKind

type RegistryListResponseKind string

The type of registry that is being configured.

const (
	RegistryListResponseKindEcr       RegistryListResponseKind = "ECR"
	RegistryListResponseKindDockerHub RegistryListResponseKind = "DockerHub"
	RegistryListResponseKindGar       RegistryListResponseKind = "GAR"
	RegistryListResponseKindDefault   RegistryListResponseKind = "default"
)

func (RegistryListResponseKind) IsKnown

func (r RegistryListResponseKind) IsKnown() bool

type RegistryNewParams

type RegistryNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Credentials for authenticating to a private external image registry. Store the
	// private credential in
	// [Secrets Store](https://developers.cloudflare.com/secrets-store/) before calling
	// the API. Refer to
	// [Image management](https://developers.cloudflare.com/containers/platform-details/image-management/)
	// for the credential required by each supported registry provider.
	Auth param.Field[RegistryNewParamsAuth] `json:"auth" api:"required"`
	// Hostname of the private registry, without a scheme or image path. Supported
	// hostnames are `docker.io`, AWS ECR hostnames, and Google Artifact Registry
	// `*-docker.pkg.dev` hostnames.
	Domain param.Field[string] `json:"domain" api:"required"`
	// Registry provider. This must match `domain`: `DockerHub` for `docker.io`, `ECR`
	// for AWS ECR, or `GAR` for Google Artifact Registry.
	Kind param.Field[RegistryNewParamsKind] `json:"kind" api:"required"`
	// Omit this field or set it to `false`. Public Docker Hub images do not require
	// registry configuration and cannot be added with this endpoint.
	IsPublic param.Field[RegistryNewParamsIsPublic] `json:"is_public"`
}

func (RegistryNewParams) MarshalJSON

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

type RegistryNewParamsAuth

type RegistryNewParamsAuth struct {
	// A reference to the private registry credential in Secrets Store. The referenced
	// secret must have the `containers` scope. Raw secret values are not accepted.
	PrivateCredential param.Field[RegistryNewParamsAuthPrivateCredential] `json:"private_credential" api:"required"`
	// The non-secret part of the registry credential: an AWS access key ID for ECR, a
	// username for Docker Hub, or a service account email for Google Artifact
	// Registry.
	PublicCredential param.Field[string] `json:"public_credential" api:"required"`
}

Credentials for authenticating to a private external image registry. Store the private credential in [Secrets Store](https://developers.cloudflare.com/secrets-store/) before calling the API. Refer to [Image management](https://developers.cloudflare.com/containers/platform-details/image-management/) for the credential required by each supported registry provider.

func (RegistryNewParamsAuth) MarshalJSON

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

type RegistryNewParamsAuthPrivateCredential

type RegistryNewParamsAuthPrivateCredential struct {
	// Name of the secret within the store.
	SecretName param.Field[string] `json:"secret_name" api:"required"`
	// Identifier of the Secrets Store containing the secret.
	StoreID param.Field[string] `json:"store_id" api:"required"`
}

A reference to the private registry credential in Secrets Store. The referenced secret must have the `containers` scope. Raw secret values are not accepted.

func (RegistryNewParamsAuthPrivateCredential) MarshalJSON

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

type RegistryNewParamsIsPublic

type RegistryNewParamsIsPublic bool

Omit this field or set it to `false`. Public Docker Hub images do not require registry configuration and cannot be added with this endpoint.

const (
	RegistryNewParamsIsPublicFalse RegistryNewParamsIsPublic = false
)

func (RegistryNewParamsIsPublic) IsKnown

func (r RegistryNewParamsIsPublic) IsKnown() bool

type RegistryNewParamsKind

type RegistryNewParamsKind string

Registry provider. This must match `domain`: `DockerHub` for `docker.io`, `ECR` for AWS ECR, or `GAR` for Google Artifact Registry.

const (
	RegistryNewParamsKindEcr       RegistryNewParamsKind = "ECR"
	RegistryNewParamsKindDockerHub RegistryNewParamsKind = "DockerHub"
	RegistryNewParamsKindGar       RegistryNewParamsKind = "GAR"
)

func (RegistryNewParamsKind) IsKnown

func (r RegistryNewParamsKind) IsKnown() bool

type RegistryNewResponse

type RegistryNewResponse struct {
	// UTC timestamp string in ISO 8601 format.
	CreatedAt string `json:"created_at" api:"required"`
	// A string representation of a domain name. See RFC-1034
	// (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name
	// is min 3 and max 253 ASCII characters.
	Domain string `json:"domain" api:"required"`
	// The type of registry that is being configured.
	Kind RegistryNewResponseKind `json:"kind"`
	// Public component of the registry credentials. For managed registries this is a
	// base64-encoded public key; for external registries the format depends on the
	// registry provider.
	PublicKey string                  `json:"public_key"`
	JSON      registryNewResponseJSON `json:"-"`
}

An image registry added in a customer account.

func (*RegistryNewResponse) UnmarshalJSON

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

type RegistryNewResponseEnvelope

type RegistryNewResponseEnvelope struct {
	Errors   []RegistryNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RegistryNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// An image registry added in a customer account.
	Result RegistryNewResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success bool                            `json:"success" api:"required"`
	JSON    registryNewResponseEnvelopeJSON `json:"-"`
}

func (*RegistryNewResponseEnvelope) UnmarshalJSON

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

type RegistryNewResponseEnvelopeErrors

type RegistryNewResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code" api:"required"`
	Message          string                                  `json:"message" api:"required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           RegistryNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             registryNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RegistryNewResponseEnvelopeErrors) UnmarshalJSON

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

type RegistryNewResponseEnvelopeErrorsSource

type RegistryNewResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    registryNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RegistryNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type RegistryNewResponseEnvelopeMessages

type RegistryNewResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code" api:"required"`
	Message          string                                    `json:"message" api:"required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           RegistryNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             registryNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RegistryNewResponseEnvelopeMessages) UnmarshalJSON

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

type RegistryNewResponseEnvelopeMessagesSource

type RegistryNewResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    registryNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RegistryNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type RegistryNewResponseKind

type RegistryNewResponseKind string

The type of registry that is being configured.

const (
	RegistryNewResponseKindEcr       RegistryNewResponseKind = "ECR"
	RegistryNewResponseKindDockerHub RegistryNewResponseKind = "DockerHub"
	RegistryNewResponseKindGar       RegistryNewResponseKind = "GAR"
	RegistryNewResponseKindDefault   RegistryNewResponseKind = "default"
)

func (RegistryNewResponseKind) IsKnown

func (r RegistryNewResponseKind) IsKnown() bool

type RegistryService

type RegistryService struct {
	Options     []option.RequestOption
	Credentials *RegistryCredentialService
}

RegistryService 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 NewRegistryService method instead.

func NewRegistryService

func NewRegistryService(opts ...option.RequestOption) (r *RegistryService)

NewRegistryService 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 (*RegistryService) Delete

Delete a registry from the account, this will prevent Containers from pulling images from the registry.

func (*RegistryService) List

Get the list of configured registries in the account.

func (*RegistryService) ListAutoPaging

Get the list of configured registries in the account.

func (*RegistryService) New

Registers credentials for a supported private external image registry so Containers can pull images from it. This endpoint does not create a registry or upload an image. Public Docker Hub images and images in the Cloudflare managed registry do not require this configuration.

Refer to [Image management](https://developers.cloudflare.com/containers/platform-details/image-management/) for supported registries and instructions for storing registry credentials.

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