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

gcore/types/cdn/logs/setting_update_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__ = ["SettingUpdateParams", "Folder"]
+
+
+class SettingUpdateParams(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.)
+    """

gcore/types/cdn/logs_aggregated_stats.py

@@ -0,0 +1,23 @@
+# 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__ = ["LogsAggregatedStats"]
+
+
+class LogsAggregatedStats(BaseModel):
+    api_1_example: Optional[object] = FieldInfo(alias="1 (example)", default=None)
+    """CDN resource ID for which statistics data is shown."""
+
+    metrics: Optional[object] = None
+    """Statistics parameters."""
+
+    raw_logs_usage: Optional[str] = None
+    """Number of resources that used raw logs."""
+
+    resource: Optional[object] = None
+    """Resources IDs by which statistics data is grouped.."""

gcore/types/cdn/logs_uploader/__init__.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .config_list_params import ConfigListParams as ConfigListParams
+from .policy_list_params import PolicyListParams as PolicyListParams
+from .target_list_params import TargetListParams as TargetListParams
+from .config_create_params import ConfigCreateParams as ConfigCreateParams
+from .config_update_params import ConfigUpdateParams as ConfigUpdateParams
+from .logs_uploader_config import LogsUploaderConfig as LogsUploaderConfig
+from .logs_uploader_policy import LogsUploaderPolicy as LogsUploaderPolicy
+from .logs_uploader_target import LogsUploaderTarget as LogsUploaderTarget
+from .policy_create_params import PolicyCreateParams as PolicyCreateParams
+from .policy_update_params import PolicyUpdateParams as PolicyUpdateParams
+from .target_create_params import TargetCreateParams as TargetCreateParams
+from .target_update_params import TargetUpdateParams as TargetUpdateParams
+from .config_replace_params import ConfigReplaceParams as ConfigReplaceParams
+from .policy_replace_params import PolicyReplaceParams as PolicyReplaceParams
+from .target_replace_params import TargetReplaceParams as TargetReplaceParams
+from .logs_uploader_config_list import LogsUploaderConfigList as LogsUploaderConfigList
+from .logs_uploader_policy_list import LogsUploaderPolicyList as LogsUploaderPolicyList
+from .logs_uploader_target_list import LogsUploaderTargetList as LogsUploaderTargetList
+from .policy_list_fields_response import PolicyListFieldsResponse as PolicyListFieldsResponse

gcore/types/cdn/logs_uploader/config_create_params.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ConfigCreateParams"]
+
+
+class ConfigCreateParams(TypedDict, total=False):
+    name: Required[str]
+    """Name of the config."""
+
+    policy: Required[int]
+    """ID of the policy that should be assigned to given config."""
+
+    target: Required[int]
+    """ID of the target to which logs should be uploaded."""
+
+    enabled: bool
+    """Enables or disables the config."""
+
+    for_all_resources: bool
+    """
+    If set to true, the config will be applied to all CDN resources. If set to
+    false, the config will be applied to the resources specified in the `resources`
+    field.
+    """
+
+    resources: Iterable[int]
+    """List of resource IDs to which the config should be applied."""

gcore/types/cdn/logs_uploader/config_list_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import TypedDict
+
+__all__ = ["ConfigListParams"]
+
+
+class ConfigListParams(TypedDict, total=False):
+    resource_ids: Iterable[int]
+    """Filter by ids of CDN resources that are assigned to given config."""
+
+    search: str
+    """Search by config name or id."""

gcore/types/cdn/logs_uploader/config_replace_params.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ConfigReplaceParams"]
+
+
+class ConfigReplaceParams(TypedDict, total=False):
+    name: Required[str]
+    """Name of the config."""
+
+    policy: Required[int]
+    """ID of the policy that should be assigned to given config."""
+
+    target: Required[int]
+    """ID of the target to which logs should be uploaded."""
+
+    enabled: bool
+    """Enables or disables the config."""
+
+    for_all_resources: bool
+    """
+    If set to true, the config will be applied to all CDN resources. If set to
+    false, the config will be applied to the resources specified in the `resources`
+    field.
+    """
+
+    resources: Iterable[int]
+    """List of resource IDs to which the config should be applied."""

gcore/types/cdn/logs_uploader/config_update_params.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import TypedDict
+
+__all__ = ["ConfigUpdateParams"]
+
+
+class ConfigUpdateParams(TypedDict, total=False):
+    enabled: bool
+    """Enables or disables the config."""
+
+    for_all_resources: bool
+    """
+    If set to true, the config will be applied to all CDN resources. If set to
+    false, the config will be applied to the resources specified in the `resources`
+    field.
+    """
+
+    name: str
+    """Name of the config."""
+
+    policy: int
+    """ID of the policy that should be assigned to given config."""
+
+    resources: Iterable[int]
+    """List of resource IDs to which the config should be applied."""
+
+    target: int
+    """ID of the target to which logs should be uploaded."""

gcore/types/cdn/logs_uploader/logs_uploader_config.py

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ...._models import BaseModel
+from ..logs_uploader_validation import LogsUploaderValidation
+
+__all__ = ["LogsUploaderConfig", "Status"]
+
+
+class Status(LogsUploaderValidation):
+    pass
+
+
+class LogsUploaderConfig(BaseModel):
+    id: Optional[int] = None
+
+    client_id: Optional[int] = None
+    """Client that owns the config."""
+
+    created: Optional[datetime] = None
+    """Time when the config was created."""
+
+    enabled: Optional[bool] = None
+    """Enables or disables the config."""
+
+    for_all_resources: Optional[bool] = None
+    """
+    If set to true, the config will be applied to all CDN resources. If set to
+    false, the config will be applied to the resources specified in the `resources`
+    field.
+    """
+
+    name: Optional[str] = None
+    """Name of the config."""
+
+    policy: Optional[int] = None
+    """ID of the policy that should be assigned to given config."""
+
+    resources: Optional[List[int]] = None
+    """List of resource IDs to which the config should be applied."""
+
+    status: Optional[Status] = None
+    """Validation status of the logs uploader config."""
+
+    target: Optional[int] = None
+    """ID of the target to which logs should be uploaded."""
+
+    updated: Optional[datetime] = None
+    """Time when the config was updated."""

gcore/types/cdn/logs_uploader/logs_uploader_config_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 .logs_uploader_config import LogsUploaderConfig
+
+__all__ = ["LogsUploaderConfigList"]
+
+LogsUploaderConfigList: TypeAlias = List[LogsUploaderConfig]

gcore/types/cdn/logs_uploader/logs_uploader_policy.py

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+
+from ...._models import BaseModel
+
+__all__ = ["LogsUploaderPolicy"]
+
+
+class LogsUploaderPolicy(BaseModel):
+    id: Optional[int] = None
+
+    client_id: Optional[int] = None
+    """Client that owns the policy."""
+
+    created: Optional[datetime] = None
+    """Time when logs uploader policy was created."""
+
+    date_format: Optional[str] = None
+    """Date format for logs."""
+
+    description: Optional[str] = None
+    """Description of the policy."""
+
+    field_delimiter: Optional[str] = None
+    """Field delimiter for logs."""
+
+    field_separator: Optional[str] = None
+    """Field separator for logs."""
+
+    fields: Optional[List[str]] = None
+    """List of fields to include in logs."""
+
+    file_name_template: Optional[str] = None
+    """Template for log file name."""
+
+    format_type: Optional[str] = None
+    """Format type for logs."""
+
+    include_empty_logs: Optional[bool] = None
+    """Include empty logs in the upload."""
+
+    include_shield_logs: Optional[bool] = None
+    """Include logs from origin shielding in the upload."""
+
+    name: Optional[str] = None
+    """Name of the policy."""
+
+    related_uploader_configs: Optional[List[int]] = None
+    """List of logs uploader configs that use this policy."""
+
+    retry_interval_minutes: Optional[int] = None
+    """Interval in minutes to retry failed uploads."""
+
+    rotate_interval_minutes: Optional[int] = None
+    """Interval in minutes to rotate logs."""
+
+    rotate_threshold_lines: Optional[int] = None
+    """Threshold in lines to rotate logs."""
+
+    rotate_threshold_mb: Optional[int] = None
+    """Threshold in MB to rotate logs."""
+
+    tags: Optional[Dict[str, str]] = None
+    """
+    Tags allow for dynamic decoration of logs by adding predefined fields to the log
+    format. These tags serve as customizable key-value pairs that can be included in
+    log entries to enhance context and readability.
+    """
+
+    updated: Optional[datetime] = None
+    """Time when logs uploader policy was updated."""

gcore/types/cdn/logs_uploader/logs_uploader_policy_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 .logs_uploader_policy import LogsUploaderPolicy
+
+__all__ = ["LogsUploaderPolicyList"]
+
+LogsUploaderPolicyList: TypeAlias = List[LogsUploaderPolicy]