# Functions

UnmarshalAPIStatusDetail unmarshals polymorphic APIStatusDetail.
UnmarshalAPIStatusDetailSlice unmarshals polymorphic slices of APIStatusDetail.

# Constants

GetMetricsRequestGroupByINSTANCENAME captures enum value "INSTANCE_NAME".
GetMetricsRequestGroupByNONE captures enum value "NONE".
PrometheusMetricsStatusERROR captures enum value "ERROR".
PrometheusMetricsStatusSUCCESS captures enum value "SUCCESS".
V1ContainerStatusContainerPhaseCONTAINERPHASEUNSPECIFIED captures enum value "CONTAINER_PHASE_UNSPECIFIED".
V1ContainerStatusContainerPhaseFAILED captures enum value "FAILED".
V1ContainerStatusContainerPhaseRUNNING captures enum value "RUNNING".
V1ContainerStatusContainerPhaseSTARTING captures enum value "STARTING".
V1ContainerStatusContainerPhaseSTOPPED captures enum value "STOPPED".
V1GetMetricsRequestGranularityDEFAULT captures enum value "DEFAULT".
V1GetMetricsRequestGranularityP1D captures enum value "P1D".
V1GetMetricsRequestGranularityPT1H captures enum value "PT1H".
V1GetMetricsRequestGranularityPT1M captures enum value "PT1M".
V1GetMetricsRequestGranularityPT5M captures enum value "PT5M".
V1GetMetricsRequestTrafficRegionALL captures enum value "ALL".
V1GetMetricsRequestTrafficRegionASIA captures enum value "ASIA".
V1GetMetricsRequestTrafficRegionEUROPE captures enum value "EUROPE".
V1GetMetricsRequestTrafficRegionINTERNAL captures enum value "INTERNAL".
V1GetMetricsRequestTrafficRegionINTERNET captures enum value "INTERNET".
V1GetMetricsRequestTrafficRegionLOCALNODE captures enum value "LOCAL_NODE".
V1GetMetricsRequestTrafficRegionLOCALPOP captures enum value "LOCAL_POP".
V1GetMetricsRequestTrafficRegionMARKETPLACE captures enum value "MARKETPLACE".
V1GetMetricsRequestTrafficRegionNORTHAMERICA captures enum value "NORTH_AMERICA".
V1GetMetricsRequestTrafficRegionOCEANIA captures enum value "OCEANIA".
V1GetMetricsRequestTrafficRegionSOUTHAMERICA captures enum value "SOUTH_AMERICA".
V1GetMetricsRequestTypeBANDWIDTH captures enum value "BANDWIDTH".
V1GetMetricsRequestTypeINSTANCE captures enum value "INSTANCE".
V1WorkloadStatusACTIVE captures enum value "ACTIVE".
V1WorkloadStatusBILLINGSUSPENDED captures enum value "BILLING_SUSPENDED".
V1WorkloadStatusINACTIVE captures enum value "INACTIVE".
V1WorkloadStatusSUSPENDED captures enum value "SUSPENDED".
VirtualMachineStatusPhaseFAILED captures enum value "FAILED".
VirtualMachineStatusPhasePENDING captures enum value "PENDING".
VirtualMachineStatusPhaseRUNNING captures enum value "RUNNING".
VirtualMachineStatusPhaseSCHEDULING captures enum value "SCHEDULING".
VirtualMachineStatusPhaseSTARTING captures enum value "STARTING".
VirtualMachineStatusPhaseSTOPPED captures enum value "STOPPED".
VirtualMachineStatusPhaseUNKNOWN captures enum value "UNKNOWN".
VolumeClaimVolumeClaimPhaseBOUND captures enum value "BOUND".
VolumeClaimVolumeClaimPhasePENDING captures enum value "PENDING".
VolumeClaimVolumeClaimPhaseUNBOUND captures enum value "UNBOUND".
VolumeClaimVolumeClaimPhaseVOLUMECLAIMPHASEUNSPECIFIED captures enum value "VOLUME_CLAIM_PHASE_UNSPECIFIED".
Workloadv1InstanceInstancePhaseCOMPLETED captures enum value "COMPLETED".
Workloadv1InstanceInstancePhaseFAILED captures enum value "FAILED".
Workloadv1InstanceInstancePhaseINSTANCEPHASEUNSPECIFIED captures enum value "INSTANCE_PHASE_UNSPECIFIED".
Workloadv1InstanceInstancePhaseRUNNING captures enum value "RUNNING".
Workloadv1InstanceInstancePhaseSCHEDULING captures enum value "SCHEDULING".
Workloadv1InstanceInstancePhaseSTARTING captures enum value "STARTING".
Workloadv1InstanceInstancePhaseSTOPPED captures enum value "STOPPED".

# Structs

ContainerStatusRunning Properties related to running containers swagger:model ContainerStatusRunning.
ContainerStatusTerminated Properties related to terminated containers swagger:model ContainerStatusTerminated.
ContainerStatusWaiting Properties related to containers that are starting up swagger:model ContainerStatusWaiting.
DataMatrix A set of time series containing a range of data points over time for each time series swagger:model DataMatrix.
DataMatrixResult Time series containing a range of data points over time for each time series swagger:model DataMatrixResult.
DataValue An individual metric data point swagger:model DataValue.
DataVector A set of time series containing a single sample for each time series, all sharing the same timestamp swagger:model DataVector.
DataVectorResult Time series containing a single sample for each time series, all sharing the same timestamp swagger:model DataVectorResult.
MetricsData The data points in a metrics collection swagger:model MetricsData.
PaginationPageInfo Information about a paginated response This is modeled after the GraphQL Relay spec to support both cursor based pagination and traditional offset based pagination.
PaginationPageRequest Pagination request information This is modeled after the GraphQL Relay spec to support both cursor based pagination and traditional offset based pagination.
PrometheusMetrics A collection of metrics swagger:model prometheusMetrics.
StackpathapiStatus stackpathapi status swagger:model stackpathapiStatus.
StackpathRPCBadRequest stackpath rpc bad request swagger:model stackpath.rpc.BadRequest.
StackpathRPCBadRequestFieldViolation stackpath rpc bad request field violation swagger:model stackpath.rpc.BadRequest.FieldViolation.
StackpathRPCHelp stackpath rpc help swagger:model stackpath.rpc.Help.
StackpathRPCHelpLink stackpath rpc help link swagger:model stackpath.rpc.Help.Link.
StackpathRPCLocalizedMessage stackpath rpc localized message swagger:model stackpath.rpc.LocalizedMessage.
StackpathRPCPreconditionFailure stackpath rpc precondition failure swagger:model stackpath.rpc.PreconditionFailure.
StackpathRPCPreconditionFailureViolation stackpath rpc precondition failure violation swagger:model stackpath.rpc.PreconditionFailure.Violation.
StackpathRPCQuotaFailure stackpath rpc quota failure swagger:model stackpath.rpc.QuotaFailure.
StackpathRPCQuotaFailureViolation stackpath rpc quota failure violation swagger:model stackpath.rpc.QuotaFailure.Violation.
StackpathRPCRequestInfo stackpath rpc request info swagger:model stackpath.rpc.RequestInfo.
StackpathRPCResourceInfo stackpath rpc resource info swagger:model stackpath.rpc.ResourceInfo.
StackpathRPCRetryInfo stackpath rpc retry info swagger:model stackpath.rpc.RetryInfo.
V1ContainerSpec The specification for the desired state of a container in a workload swagger:model v1ContainerSpec.
V1ContainerStatus The status of a container in a workload swagger:model v1ContainerStatus.
V1CreateWorkloadRequest v1 create workload request swagger:model v1CreateWorkloadRequest.
V1CreateWorkloadResponse A response from a request to add a workload to a stack swagger:model v1CreateWorkloadResponse.
V1DeploymentSpec A deployment's specification swagger:model v1DeploymentSpec.
V1DockerRegistryCredentials The authentication configuration that should be used to pull images from a docker registry swagger:model v1DockerRegistryCredentials.
V1EnvironmentVariable The location to obtain a value for an environment variable swagger:model v1EnvironmentVariable.
V1GetLocationsResponse A response from a request to retrieve the locations a workload may be created at swagger:model v1GetLocationsResponse.
V1GetWorkloadInstanceResponse A response from a request to retrieve a workload's instances swagger:model v1GetWorkloadInstanceResponse.
V1GetWorkloadInstancesResponse A response from a request to retrieve a workload's instances swagger:model v1GetWorkloadInstancesResponse.
V1GetWorkloadResponse A response from a request to retrieve an individual workload swagger:model v1GetWorkloadResponse.
V1GetWorkloadsResponse A response from a request to retrieve a stack's workloads swagger:model v1GetWorkloadsResponse.
V1HTTPGetAction Execute an HTTP GET request against an endpoint running on an instance swagger:model v1HTTPGetAction.
V1ImagePullCredential The credentials that should be used to pull the container image swagger:model v1ImagePullCredential.
V1InstancePort A named port for an instance of a workload swagger:model v1InstancePort.
V1InstanceVolumeMount Describes mounting a volume on containers or vms in an instance swagger:model v1InstanceVolumeMount.
V1LogChunk A chunk of raw log data swagger:model v1LogChunk.
V1MatchExpression An expression to match selectors against a set of values swagger:model v1MatchExpression.
V1Metadata Metadata associated with an entity swagger:model v1Metadata.
V1MetricSpec v1 metric spec swagger:model v1MetricSpec.
V1NetworkInterface Network interfaces that will be created on instances in the workload swagger:model v1NetworkInterface.
V1Probe A health check probe against a workload instance to determine if it is alive or ready to receive traffic swagger:model v1Probe.
V1ResourceRequirements Resource requirements for an object Resource requirements are key/value pairs.
V1ScaleSettings v1 scale settings swagger:model v1ScaleSettings.
V1Target How instances in a workload should be deployed swagger:model v1Target.
V1TargetSpec The specification for a target swagger:model v1TargetSpec.
V1TCPSocketAction Connect to an instance's TCP port swagger:model v1TCPSocketAction.
V1UpdateWorkloadRequest v1 update workload request swagger:model v1UpdateWorkloadRequest.
V1UpdateWorkloadResponse A response from a request to update a workload swagger:model v1UpdateWorkloadResponse.
V1VirtualMachineSpec The specification for the desired state of a virtual machine in a workload swagger:model v1VirtualMachineSpec.
V1VirtualMachineStatus The status of a Virtual Machine swagger:model v1VirtualMachineStatus.
V1VolumeClaim A claim for a volume Volumes may be attached to workload instance containers or virtual machines swagger:model v1VolumeClaim.
V1VolumeClaimSpec The specification for a volume claim swagger:model v1VolumeClaimSpec.
V1Workload A computing workload Workloads define a computing application to deploy to StackPath's edge network.
V1WorkloadSpec The specification for the desired state of a workload swagger:model v1WorkloadSpec.
Workloadv1Instance An instance of a workload deployment swagger:model workloadv1Instance.
Workloadv1Location Geographic location information swagger:model workloadv1Location.
Workloadv1NetworkInterfaceStatus Network interfaces that are attached to an instance in a workload swagger:model workloadv1NetworkInterfaceStatus.

# Interfaces

APIStatusDetail api status detail swagger:discriminator apiStatusDetail @type.

# Type aliases

GetMetricsRequestGroupBy The available fields to group instance metrics by swagger:model GetMetricsRequestGroupBy.
PrometheusMetricsStatus A metrics query's resulting status swagger:model prometheusMetricsStatus.
V1ContainerSpecMapEntry A string to container configuration key/value pair swagger:model v1ContainerSpecMapEntry.
V1ContainerStatusContainerPhase Which phase of runtime a container is currently in - CONTAINER_PHASE_UNSPECIFIED: The container has not reported a state back or StackPath is unable to determine the container's state - STARTING: The container is starting up - RUNNING: The container is running - FAILED: The container has terminated due to a failure - STOPPED: The container was terminated by the user swagger:model v1ContainerStatusContainerPhase.
V1EnvironmentVariableMapEntry A string to environment variable key/value pair swagger:model v1EnvironmentVariableMapEntry.
V1GetMetricsRequestGranularity The time granularity of retrieved metrics This field does not apply when retrieving INSTANCE type metrics - DEFAULT: The current default is PT5M - PT5M: Metrics every five minutes - PT1H: Metrics every hour - P1D: Metrics every day - PT1M: Metrics every one minute swagger:model v1GetMetricsRequestGranularity.
V1GetMetricsRequestTrafficRegion A geographic or network region to filter traffic metrics for This field does not apply when retrieving INSTANCE type metrics swagger:model v1GetMetricsRequestTrafficRegion.
V1GetMetricsRequestType The types of metrics that can be retrieved - BANDWIDTH: Bandwidth ingress and egress metrics - INSTANCE: Instance CPU, memory, and filesystem metrics swagger:model v1GetMetricsRequestType.
V1InstancePortMapEntry A string to network port key/value pair swagger:model v1InstancePortMapEntry.
V1StringMapEntry A string to string key/value pair swagger:model v1StringMapEntry.
V1TargetMapEntry A string to deployment target key/value pair swagger:model v1TargetMapEntry.
V1VirtualMachineSpecMapEntry A string to virtual machine configuration key/value pair swagger:model v1VirtualMachineSpecMapEntry.
V1WorkloadStatus Which status a workload is currently in - ACTIVE: The workload is active - SUSPENDED: The workload is suspended - BILLING_SUSPENDED: The workload is suspended due to non-payment - INACTIVE: The workload is inactive or has been deleted swagger:model v1WorkloadStatus.
V1WrappedImagePullCredentials The credentials that should be used to pull the container image The credentials that should be used to pull the container image swagger:model v1WrappedImagePullCredentials.
VirtualMachineStatusPhase virtual machine status phase swagger:model VirtualMachineStatusPhase.
VolumeClaimVolumeClaimPhase Which phase a volume claim is currently in - VOLUME_CLAIM_PHASE_UNSPECIFIED: StackPath is unable to determine the volume claim's state - PENDING: The volume claim is pending - UNBOUND: The volume claim is unbound - BOUND: The volume claim is bound to an instance swagger:model VolumeClaimVolumeClaimPhase.
Workloadv1InstanceInstancePhase An instance's startup state - INSTANCE_PHASE_UNSPECIFIED: StackPath is unable to determine the instance's startup state - STARTING: The instance is still initializing - RUNNING: The instance is running - FAILED: The instance failed to start - COMPLETED: The instance finished running - SCHEDULING: The instance is being scheduled - STOPPED: The instance is stopped swagger:model workloadv1InstanceInstancePhase.