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

gcore/types/cdn/log_list_params.py

@@ -0,0 +1,273 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["LogListParams"]
+
+
+class LogListParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """
+    Start date and time of the requested time period (ISO 8601/RFC 3339 format,
+    UTC.)
+
+    Difference between "from" and "to" cannot exceed 6 hours.
+
+    Examples:
+
+    - &from=2021-06-14T00:00:00Z
+    - &from=2021-06-14T00:00:00.000Z
+    """
+
+    to: Required[str]
+    """End date and time of the requested time period (ISO 8601/RFC 3339 format, UTC.)
+
+    Difference between "from" and "to" cannot exceed 6 hours.
+
+    Examples:
+
+    - &to=2021-06-15T00:00:00Z
+    - &to=2021-06-15T00:00:00.000Z
+    """
+
+    cache_status_eq: Annotated[str, PropertyInfo(alias="cache_status__eq")]
+    """Caching status.
+
+    Possible values: 'MISS', 'BYPASS', 'EXPIRED', 'STALE', 'PENDING', 'UPDATING',
+    'REVALIDATED', 'HIT', '-'.
+    """
+
+    cache_status_in: Annotated[str, PropertyInfo(alias="cache_status__in")]
+    """List of caching statuses.
+
+    Possible values: 'MISS', 'BYPASS', 'EXPIRED', 'STALE', 'PENDING', 'UPDATING',
+    'REVALIDATED', 'HIT', '-'. Values should be separated by a comma.
+    """
+
+    cache_status_ne: Annotated[str, PropertyInfo(alias="cache_status__ne")]
+    """Caching status not equal to the specified value.
+
+    Possible values: 'MISS', 'BYPASS', 'EXPIRED', 'STALE', 'PENDING', 'UPDATING',
+    'REVALIDATED', 'HIT', '-'.
+    """
+
+    cache_status_not_in: Annotated[str, PropertyInfo(alias="cache_status__not_in")]
+    """List of caching statuses not equal to the specified values.
+
+    Possible values: 'MISS', 'BYPASS', 'EXPIRED', 'STALE', 'PENDING', 'UPDATING',
+    'REVALIDATED', 'HIT', '-'. Values should be separated by a comma.
+    """
+
+    client_ip_eq: Annotated[str, PropertyInfo(alias="client_ip__eq")]
+    """IP address of the client who sent the request."""
+
+    client_ip_in: Annotated[str, PropertyInfo(alias="client_ip__in")]
+    """List of IP addresses of the clients who sent the request."""
+
+    client_ip_ne: Annotated[str, PropertyInfo(alias="client_ip__ne")]
+    """IP address of the client who did not send the request."""
+
+    client_ip_not_in: Annotated[str, PropertyInfo(alias="client_ip__not_in")]
+    """List of IP addresses of the clients who did not send the request."""
+
+    cname_contains: Annotated[str, PropertyInfo(alias="cname__contains")]
+    """Part of the custom domain of the requested CDN resource.
+
+    Minimum length is 3 characters.
+    """
+
+    cname_eq: Annotated[str, PropertyInfo(alias="cname__eq")]
+    """Custom domain of the requested CDN resource."""
+
+    cname_in: Annotated[str, PropertyInfo(alias="cname__in")]
+    """List of custom domains of the requested CDN resource.
+
+    Values should be separated by a comma.
+    """
+
+    cname_ne: Annotated[str, PropertyInfo(alias="cname__ne")]
+    """Custom domain of the requested CDN resource not equal to the specified value."""
+
+    cname_not_in: Annotated[str, PropertyInfo(alias="cname__not_in")]
+    """
+    List of custom domains of the requested CDN resource not equal to the specified
+    values. Values should be separated by a comma.
+    """
+
+    datacenter_eq: Annotated[str, PropertyInfo(alias="datacenter__eq")]
+    """Data center where request was processed."""
+
+    datacenter_in: Annotated[str, PropertyInfo(alias="datacenter__in")]
+    """List of data centers where request was processed.
+
+    Values should be separated by a comma.
+    """
+
+    datacenter_ne: Annotated[str, PropertyInfo(alias="datacenter__ne")]
+    """Data center where request was not processed."""
+
+    datacenter_not_in: Annotated[str, PropertyInfo(alias="datacenter__not_in")]
+    """List of data centers where request was not processed.
+
+    Values should be separated by a comma.
+    """
+
+    fields: str
+    """A comma-separated list of returned fields.
+
+    Supported fields are presented in the responses section.
+
+    Example:
+
+    - &fields=timestamp,path,status
+    """
+
+    limit: int
+    """Maximum number of log records in the response."""
+
+    method_eq: Annotated[str, PropertyInfo(alias="method__eq")]
+    """Request HTTP method.
+
+    Possible values: 'CONNECT', 'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST',
+    'PUT', 'TRACE'.
+    """
+
+    method_in: Annotated[str, PropertyInfo(alias="method__in")]
+    """Request HTTP method.
+
+    Possible values: 'CONNECT', 'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST',
+    'PUT', 'TRACE'. Values should be separated by a comma.
+    """
+
+    method_ne: Annotated[str, PropertyInfo(alias="method__ne")]
+    """Request HTTP method.
+
+    Possible values: 'CONNECT', 'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST',
+    'PUT', 'TRACE'.
+    """
+
+    method_not_in: Annotated[str, PropertyInfo(alias="method__not_in")]
+    """Request HTTP method.
+
+    Possible values: 'CONNECT', 'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST',
+    'PUT', 'TRACE'. Values should be separated by a comma.
+    """
+
+    offset: int
+    """
+    Number of log records to skip starting from the beginning of the requested
+    period.
+    """
+
+    ordering: str
+    """Sorting rules.
+
+    Possible values:
+
+    - **method** - Request HTTP method.
+    - **`client_ip`** - IP address of the client who sent the request.
+    - **status** - Status code in the response.
+    - **size** - Response size in bytes.
+    - **cname** - Custom domain of the requested resource.
+    - **`resource_id`** - ID of the requested CDN resource.
+    - **`cache_status`** - Caching status.
+    - **datacenter** - Data center where request was processed.
+    - **timestamp** - Date and time when the request was made.
+
+    Parameter may have multiple values separated by a comma.
+
+    By default, ascending sorting is applied. To sort in descending order, add '-'
+    prefix.
+
+    Example:
+
+    - &ordering=-timestamp,status
+    """
+
+    resource_id_eq: Annotated[int, PropertyInfo(alias="resource_id__eq")]
+    """ID of the requested CDN resource equal to the specified value."""
+
+    resource_id_gt: Annotated[int, PropertyInfo(alias="resource_id__gt")]
+    """ID of the requested CDN resource greater than the specified value."""
+
+    resource_id_gte: Annotated[int, PropertyInfo(alias="resource_id__gte")]
+    """ID of the requested CDN resource greater than or equal to the specified value."""
+
+    resource_id_in: Annotated[str, PropertyInfo(alias="resource_id__in")]
+    """List of IDs of the requested CDN resource.
+
+    Values should be separated by a comma.
+    """
+
+    resource_id_lt: Annotated[int, PropertyInfo(alias="resource_id__lt")]
+    """ID of the requested CDN resource less than the specified value."""
+
+    resource_id_lte: Annotated[int, PropertyInfo(alias="resource_id__lte")]
+    """ID of the requested CDN resource less than or equal to the specified value."""
+
+    resource_id_ne: Annotated[int, PropertyInfo(alias="resource_id__ne")]
+    """ID of the requested CDN resource not equal to the specified value."""
+
+    resource_id_not_in: Annotated[str, PropertyInfo(alias="resource_id__not_in")]
+    """List of IDs of the requested CDN resource not equal to the specified values.
+
+    Values should be separated by a comma.
+    """
+
+    size_eq: Annotated[int, PropertyInfo(alias="size__eq")]
+    """Response size in bytes equal to the specified value."""
+
+    size_gt: Annotated[int, PropertyInfo(alias="size__gt")]
+    """Response size in bytes greater than the specified value."""
+
+    size_gte: Annotated[int, PropertyInfo(alias="size__gte")]
+    """Response size in bytes greater than or equal to the specified value."""
+
+    size_in: Annotated[str, PropertyInfo(alias="size__in")]
+    """List of response sizes in bytes. Values should be separated by a comma."""
+
+    size_lt: Annotated[int, PropertyInfo(alias="size__lt")]
+    """Response size in bytes less than the specified value."""
+
+    size_lte: Annotated[int, PropertyInfo(alias="size__lte")]
+    """Response size in bytes less than or equal to the specified value."""
+
+    size_ne: Annotated[int, PropertyInfo(alias="size__ne")]
+    """Response size in bytes not equal to the specified value."""
+
+    size_not_in: Annotated[str, PropertyInfo(alias="size__not_in")]
+    """List of response sizes in bytes not equal to the specified values.
+
+    Values should be separated by
+    """
+
+    status_eq: Annotated[int, PropertyInfo(alias="status__eq")]
+    """Status code in the response equal to the specified value."""
+
+    status_gt: Annotated[int, PropertyInfo(alias="status__gt")]
+    """Status code in the response greater than the specified value."""
+
+    status_gte: Annotated[int, PropertyInfo(alias="status__gte")]
+    """Status code in the response greater than or equal to the specified value."""
+
+    status_in: Annotated[str, PropertyInfo(alias="status__in")]
+    """List of status codes in the response. Values should be separated by a comma."""
+
+    status_lt: Annotated[int, PropertyInfo(alias="status__lt")]
+    """Status code in the response less than the specified value."""
+
+    status_lte: Annotated[int, PropertyInfo(alias="status__lte")]
+    """Status code in the response less than or equal to the specified value."""
+
+    status_ne: Annotated[int, PropertyInfo(alias="status__ne")]
+    """Status code in the response not equal to the specified value."""
+
+    status_not_in: Annotated[str, PropertyInfo(alias="status__not_in")]
+    """List of status codes not in the response.
+
+    Values should be separated by a comma.
+    """

gcore/types/cdn/logs/__init__.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .log_settings import LogSettings as LogSettings
+from .setting_create_params import SettingCreateParams as SettingCreateParams
+from .setting_update_params import SettingUpdateParams as SettingUpdateParams

gcore/types/cdn/logs/log_settings.py

@@ -0,0 +1,172 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ...._models import BaseModel
+
+__all__ = ["LogSettings", "Folder"]
+
+
+class Folder(BaseModel):
+    id: Optional[int] = None
+    """Parameter meaning depends on the value of the "`storage_type`" value:
+
+    - **s3** - S3 bucket ID.
+    - **ftp/sftp** - FTP/SFTP folder ID.
+    """
+
+    bucket: Optional[str] = None
+    """S3 bucket name.
+
+    The field is required if "`storage_type`": **s3**.
+    """
+
+    cdn_resource: Optional[int] = None
+    """CDN resource ID."""
+
+    folder: Optional[str] = None
+    """Parameter meaning depends on the value of the "`storage_type`" value:
+
+    - **s3** - S3 bucket sub-folder name (optional.)
+    - **ftp/sftp** - FTP/SFTP folder name (required.)
+    """
+
+
+class LogSettings(BaseModel):
+    all_resources_bucket: Optional[str] = None
+    """Name of the S3 bucket to which logs of all CDN resources are delivered.
+
+    Applicable for "`storage_type`": S3.
+    """
+
+    all_resources_folder: Optional[str] = None
+    """Parameter meaning depends on the value of the "`storage_type`" value:
+
+    - **s3** - Name of the S3 bucket sub-folder to which logs for all CDN resources
+      are delivered.
+    - **ftp/sftp** - Name of the folder (or path) to which logs for all CDN
+      resources are delivered.
+    """
+
+    archive_size_mb: Optional[int] = None
+    """
+    The size of a single piece of the archive in MB. In case of **null** value logs
+    are delivered without slicing.
+    """
+
+    client: Optional[int] = None
+    """Client ID."""
+
+    comment: Optional[str] = None
+    """System comment on the status of settings, if they are suspended."""
+
+    enabled: Optional[bool] = None
+    """Enables or disables a log forwarding feature.
+
+    Possible values:
+
+    - **true** - log forwarding feature is active.
+    - **false** - log forwarding feature is deactivated.
+    """
+
+    folders: Optional[List[Folder]] = None
+    """List of folders/buckets for receiving CDN resources logs."""
+
+    for_all_resources: Optional[bool] = None
+    """
+    Defines whether logs of all CDN resources are delivered to one folder/bucket or
+    to separate ones.
+
+    Possible values:
+
+    - **true** - Logs of all CDN resources are delivered to one folder/bucket.
+    - **false** - Logs of CDN resources are delivered to separate folders/buckets.
+    """
+
+    ftp_hostname: Optional[str] = None
+    """FTP storage hostname."""
+
+    ftp_login: Optional[str] = None
+    """FTP storage login."""
+
+    ftp_prepend_folder: Optional[str] = None
+    """Name of prepend FTP folder for log delivery."""
+
+    ignore_empty_logs: Optional[bool] = None
+    """Enables or disables the forwarding of empty logs.
+
+    Possible values:
+
+    - **true** - Empty logs are not sent.
+    - **false** - Empty logs are sent.
+    """
+
+    s3_access_key_id: Optional[str] = None
+    """Access key ID for the S3 account.
+
+    Access Key ID is 20 alpha-numeric characters like 022QF06E7MXBSH9DHM02
+    """
+
+    s3_aws_region: Optional[str] = None
+    """Amazon AWS region."""
+
+    s3_bucket_location: Optional[str] = None
+    """S3 storage location.
+
+    Restrictions:
+
+    - Maximum 255 symbols.
+    - Latin letters (A-Z, a-z,) digits (0-9,) dots, colons, dashes, and underscores
+      (.:\\__-).
+    """
+
+    s3_host_bucket: Optional[str] = None
+    """S3 storage bucket hostname.
+
+    Restrictions:
+
+    - Maximum 255 symbols.
+    - Latin letters (A-Z, a-z,) digits (0-9,) dots, colons, dashes, and underscores.
+    """
+
+    s3_hostname: Optional[str] = None
+    """S3 storage hostname."""
+
+    s3_type: Optional[str] = None
+    """Storage type compatible with S3.
+
+    Possible values:
+
+    - **amazon** – AWS S3 storage.
+    - **other** – Other (not AWS) S3 compatible storage.
+    """
+
+    sftp_hostname: Optional[str] = None
+    """SFTP storage hostname."""
+
+    sftp_login: Optional[str] = None
+    """SFTP storage login."""
+
+    sftp_prepend_folder: Optional[str] = None
+    """Name of prepend SFTP folder for log delivery."""
+
+    status: Optional[str] = None
+    """Log delivery status.
+
+    Possible values:
+
+    - **ok** – All/part of attempts to deliver logs were successful.
+    - **failed** – All attempts to deliver logs failed.
+    - **pending** - No logs delivery attempts yet.
+    - **disabled** - Log delivery is disabled.
+    """
+
+    storage_type: Optional[str] = None
+    """Storage type.
+
+    Possible values:
+
+    - **ftp**
+    - **sftp**
+    - **s3**
+    """

gcore/types/cdn/logs/setting_create_params.py

@@ -0,0 +1,200 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SettingCreateParams", "Folder"]
+
+
+class SettingCreateParams(TypedDict, total=False):
+    all_resources_bucket: Required[str]
+    """Name of the S3 bucket to which logs for all CDN resources are delivered."""
+
+    all_resources_folder: Required[str]
+    """Parameter meaning depends on the value of the "`storage_type`" value:
+
+    - If "`storage_type`": s3 - Name of the S3 bucket sub-folder to which logs for
+      all CDN resources are delivered.
+    - If "`storage_type`": ftp/sftp - Name of the folder (or path) to which logs for
+      all CDN resources are delivered.
+    """
+
+    folders: Required[Iterable[Folder]]
+    """List of folders/buckets for receiving CDN resources logs."""
+
+    for_all_resources: Required[bool]
+    """
+    Defines whether logs of all CDN resources are delivered to one folder/bucket or
+    to separate ones.
+
+    Possible values:
+
+    - **true** - Logs of all CDN resources are delivered to one folder/bucket.
+    - **false** - Logs of different CDN resources are delivered to separate
+      folders/buckets.
+    """
+
+    ftp_hostname: Required[str]
+    """FTP storage hostname."""
+
+    ftp_login: Required[str]
+    """FTP storage login."""
+
+    ftp_password: Required[str]
+    """FTP storage password."""
+
+    s3_access_key_id: Required[str]
+    """Access key ID for the S3 account.
+
+    Access Key ID is 20 alpha-numeric characters like 022QF06E7MXBSH9DHM02
+    """
+
+    s3_hostname: Required[str]
+    """S3 storage hostname.
+
+    It is required if "`s3_type`": other.
+    """
+
+    s3_secret_key: Required[str]
+    """Secret access key for the S3 account.
+
+    Secret Access Key is 20-50 alpha-numeric-slash-plus characters like
+    kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct
+    """
+
+    s3_type: Required[str]
+    """Storage type compatible with S3.
+
+    Possible values:
+
+    - **amazon** – AWS S3 storage.
+    - **other** – Other (not AWS) S3 compatible storage.
+    """
+
+    sftp_hostname: Required[str]
+    """SFTP storage hostname."""
+
+    sftp_login: Required[str]
+    """SFTP storage login."""
+
+    sftp_password: Required[str]
+    """SFTP storage password.
+
+    It should be empty if "`sftp_private_key`" is set.
+    """
+
+    storage_type: Required[str]
+    """Storage type.
+
+    Possible values:
+
+    - **ftp**
+    - **sftp**
+    - **s3**
+    """
+
+    archive_size_mb: Optional[int]
+    """
+    The size of a single piece of the archive in MB. In case of **null** value logs
+    are delivered without slicing.
+    """
+
+    enabled: bool
+    """Enables or disables a log forwarding feature.
+
+    Possible values:
+
+    - **true** - log forwarding feature is active.
+    - **false** - log forwarding feature is deactivated.
+    """
+
+    ftp_prepend_folder: str
+    """Name of the FTP prepend folder for log delivery.
+
+    **Null** is allowed.
+    """
+
+    ignore_empty_logs: bool
+    """Enables or disables the forwarding of empty logs.
+
+    Possible values:
+
+    - **true** - Empty logs are not sent.
+    - **false** - Empty logs are sent.
+    """
+
+    s3_aws_region: int
+    """Amazon AWS region."""
+
+    s3_bucket_location: str
+    """Location of S3 storage.
+
+    Restrictions:
+
+    - Maximum of 255 symbols.
+    - Latin letters (A-Z, a-z), digits (0-9), dots, colons, dashes, and underscores
+      (.:\\__-).
+    """
+
+    s3_host_bucket: str
+    """S3 bucket hostname.
+
+    Restrictions:
+
+    - Maximum of 255 symbols.
+    - Latin letters (A-Z, a-z,) digits (0-9,) dots, colons, dashes, and underscores.
+    - Required if "`s3_type`": other.
+    """
+
+    sftp_key_passphrase: str
+    """Passphrase for SFTP private key.
+
+    Restrictions:
+
+    - Should be set if private key encoded with passphrase.
+    - Should be empty if "`sftp_password`" is set.
+    """
+
+    sftp_prepend_folder: str
+    """Name of the SFTP prepend folder for log delivery.
+
+    **Null** is allowed.
+    """
+
+    sftp_private_key: str
+    """Private key for SFTP authorization.
+
+    Possible values:
+
+    - **RSA**
+    - **ED25519**
+
+    It should be empty if "`sftp_password`" is set.
+    """
+
+
+class Folder(TypedDict, total=False):
+    id: int
+    """Parameter meaning depends on the value of the "`storage_type`" value:
+
+    - **s3** - S3 bucket ID.
+    - **ftp/sftp** - FTP/SFTP folder ID.
+    """
+
+    bucket: str
+    """S3 bucket name.
+
+    The field is required if "`storage_type`": **s3**.
+    """
+
+    cdn_resource: int
+    """CDN resource ID."""
+
+    folder: str
+    """Parameter meaning depends on the value of the "`storage_type`" value:
+
+    - **s3** - S3 bucket sub-folder name (optional.)
+    - **ftp/sftp** - FTP/SFTP folder name (required.)
+    """