gcore 0.13.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

gcore/types/cdn/origin_groups.py

@@ -0,0 +1,212 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = ["OriginGroups", "NoneAuth", "NoneAuthSource", "AwsSignatureV4", "AwsSignatureV4Auth"]
+
+
+class NoneAuthSource(BaseModel):
+    backup: Optional[bool] = None
+    """
+    Defines whether the origin is a backup, meaning that it will not be used until
+    one of active origins become unavailable.
+
+    Possible values:
+
+    - **true** - Origin is a backup.
+    - **false** - Origin is not a backup.
+    """
+
+    enabled: Optional[bool] = None
+    """Enables or disables an origin source in the origin group.
+
+    Possible values:
+
+    - **true** - Origin is enabled and the CDN uses it to pull content.
+    - **false** - Origin is disabled and the CDN does not use it to pull content.
+
+    Origin group must contain at least one enabled origin.
+    """
+
+    source: Optional[str] = None
+    """IP address or domain name of the origin and the port, if custom port is used."""
+
+
+class NoneAuth(BaseModel):
+    id: Optional[int] = None
+    """Origin group ID."""
+
+    auth_type: Optional[str] = None
+    """Origin authentication type.
+
+    Possible values:
+
+    - **none** - Used for public origins.
+    - **awsSignatureV4** - Used for S3 storage.
+    """
+
+    has_related_resources: Optional[bool] = None
+    """Defines whether the origin group has related CDN resources.
+
+    Possible values:
+
+    - **true** - Origin group has related CDN resources.
+    - **false** - Origin group does not have related CDN resources.
+    """
+
+    name: Optional[str] = None
+    """Origin group name."""
+
+    path: Optional[str] = None
+    """Parameter is **deprecated**."""
+
+    proxy_next_upstream: Optional[List[str]] = None
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+    sources: Optional[List[NoneAuthSource]] = None
+    """List of origin sources in the origin group."""
+
+    use_next: Optional[bool] = None
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+
+class AwsSignatureV4Auth(BaseModel):
+    s3_access_key_id: str
+    """Access key ID for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), colon, dash, and underscore.
+    - From 3 to 512 characters.
+    """
+
+    s3_bucket_name: str
+    """S3 bucket name.
+
+    Restrictions:
+
+    - Maximum 128 characters.
+    """
+
+    s3_secret_access_key: str
+    """Secret access key for the S3 account.
+
+    Restrictions:
+
+    - Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and
+      underscores.
+    - If "`s3_type`": amazon, length should be 40 characters.
+    - If "`s3_type`": other, length should be from 16 to 255 characters.
+    """
+
+    s3_type: str
+    """Storage type compatible with S3.
+
+    Possible values:
+
+    - **amazon** – AWS S3 storage.
+    - **other** – Other (not AWS) S3 compatible storage.
+    """
+
+    s3_region: Optional[str] = None
+    """S3 storage region.
+
+    The parameter is required, if "`s3_type`": amazon.
+    """
+
+    s3_storage_hostname: Optional[str] = None
+    """S3 storage hostname.
+
+    The parameter is required, if "`s3_type`": other.
+    """
+
+
+class AwsSignatureV4(BaseModel):
+    id: Optional[int] = None
+    """Origin group ID."""
+
+    auth: Optional[AwsSignatureV4Auth] = None
+    """Credentials to access the private bucket."""
+
+    auth_type: Optional[str] = None
+    """Authentication type.
+
+    **awsSignatureV4** value is used for S3 storage.
+    """
+
+    has_related_resources: Optional[bool] = None
+    """Defines whether the origin group has related CDN resources.
+
+    Possible values:
+
+    - **true** - Origin group has related CDN resources.
+    - **false** - Origin group does not have related CDN resources.
+    """
+
+    name: Optional[str] = None
+    """Origin group name."""
+
+    path: Optional[str] = None
+    """Parameter is **deprecated**."""
+
+    proxy_next_upstream: Optional[List[str]] = None
+    """Defines cases when the request should be passed on to the next origin.
+
+    Possible values:
+
+    - **error** - an error occurred while establishing a connection with the origin,
+      passing a request to it, or reading the response header
+    - **timeout** - a timeout has occurred while establishing a connection with the
+      origin, passing a request to it, or reading the response header
+    - **`invalid_header`** - a origin returned an empty or invalid response
+    - **`http_403`** - a origin returned a response with the code 403
+    - **`http_404`** - a origin returned a response with the code 404
+    - **`http_429`** - a origin returned a response with the code 429
+    - **`http_500`** - a origin returned a response with the code 500
+    - **`http_502`** - a origin returned a response with the code 502
+    - **`http_503`** - a origin returned a response with the code 503
+    - **`http_504`** - a origin returned a response with the code 504
+    """
+
+    use_next: Optional[bool] = None
+    """
+    Defines whether to use the next origin from the origin group if origin responds
+    with the cases specified in `proxy_next_upstream`. If you enable it, you must
+    specify cases in `proxy_next_upstream`.
+
+    Possible values:
+
+    - **true** - Option is enabled.
+    - **false** - Option is disabled.
+    """
+
+
+OriginGroups: TypeAlias = Union[NoneAuth, AwsSignatureV4]

gcore/types/cdn/origin_groups_list.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .origin_groups import OriginGroups
+
+__all__ = ["OriginGroupsList"]
+
+OriginGroupsList: TypeAlias = List[OriginGroups]

gcore/types/cdn/public_ip_list.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["PublicIPList"]
+
+
+class PublicIPList(BaseModel):
+    addresses: Optional[List[str]] = None
+    """List of IPv4 addresses."""
+
+    addresses_v6: Optional[List[str]] = None
+    """List of IPv6 addresses."""

gcore/types/cdn/public_network_list.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["PublicNetworkList"]
+
+
+class PublicNetworkList(BaseModel):
+    addresses: Optional[List[str]] = None
+    """List of IPv4 networks."""
+
+    addresses_v6: Optional[List[str]] = None
+    """List of IPv6 networks."""

gcore/types/cdn/purge_status.py

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["PurgeStatus", "Resource"]
+
+
+class Resource(BaseModel):
+    id: Optional[int] = None
+    """Resource ID."""
+
+    cname: Optional[str] = None
+    """CNAME of the resource."""
+
+
+class PurgeStatus(BaseModel):
+    created: Optional[str] = None
+    """Date and time when the purge was created (ISO 8601/RFC 3339 format, UTC)."""
+
+    payload: Optional[object] = None
+    """Purge payload depends on purge type.
+
+    Possible values:
+
+    - **urls** - Purge by URL.
+    - **paths** - Purge by Pattern and purge All.
+    """
+
+    purge_id: Optional[int] = None
+    """Purge ID."""
+
+    purge_type: Optional[str] = None
+    """Contains the name of the purge request type.
+
+    Possible values:
+
+    - **`purge_by_pattern`** - Purge by Pattern.
+    - **`purge_by_url`** - Purge by URL.
+    - **`purge_all`** - Purge All.
+    """
+
+    resource: Optional[Resource] = None
+
+    status: Optional[Literal["In progress", "Successful", "Failed"]] = None
+    """Purge status.
+
+    Possible values:
+
+    - **In progress** - Purge is in progress.
+    - **Successful** - Purge was successful.
+    - **Failed** - Purge failed.
+    """

gcore/types/cdn/resource_aggregated_stats.py

@@ -0,0 +1,80 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ResourceAggregatedStats"]
+
+
+class ResourceAggregatedStats(BaseModel):
+    api_1_example: Optional[object] = FieldInfo(alias="1 (example)", default=None)
+    """CDN resource ID for which statistics data is shown."""
+
+    api_95_percentile: Optional[int] = FieldInfo(alias="95_percentile", default=None)
+    """95 percentile bandwidth value"""
+
+    backblaze_bytes: Optional[int] = None
+    """Traffic in bytes from Backblaze origin."""
+
+    cache_hit_traffic_ratio: Optional[int] = None
+    """Formula: 1 - `upstream_bytes` / `sent_bytes`.
+
+    We deduct the non-cached traffic from the total traffic amount
+    """
+
+    cis_example: Optional[object] = FieldInfo(alias="cis (example)", default=None)
+    """Region by which statistics data is grouped."""
+
+    max_bandwidth: Optional[int] = None
+    """Maximum bandwidth"""
+
+    metrics: Optional[object] = None
+    """Statistics parameters."""
+
+    min_bandwidth: Optional[int] = None
+    """Minimum bandwidth"""
+
+    region: Optional[object] = None
+    """Regions by which statistics data is grouped."""
+
+    requests: Optional[int] = None
+    """Number of requests to edge servers."""
+
+    resource: Optional[object] = None
+    """Resources IDs by which statistics data is grouped."""
+
+    response_types: Optional[object] = None
+    """Statistics by content type.
+
+    It returns a number of responses for content with different MIME types.
+    """
+
+    responses_2xx: Optional[int] = None
+    """Number of 2xx response codes."""
+
+    responses_3xx: Optional[int] = None
+    """Number of 3xx response codes."""
+
+    responses_4xx: Optional[int] = None
+    """Number of 4xx response codes."""
+
+    responses_5xx: Optional[int] = None
+    """Number of 5xx response codes."""
+
+    responses_hit: Optional[int] = None
+    """Number of responses with the header Cache: HIT."""
+
+    responses_miss: Optional[int] = None
+    """Number of responses with the header Cache: MISS."""
+
+    sent_bytes: Optional[int] = None
+    """Traffic in bytes from CDN servers to clients."""
+
+    total_bytes: Optional[int] = None
+    """Upstream bytes and `sent_bytes` combined."""
+
+    upstream_bytes: Optional[int] = None
+    """Traffic in bytes from the upstream to CDN servers."""