diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 157f0355..51acdaa4 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.36.0" + ".": "0.37.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 39639bb1..ed94b735 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 647 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gcore%2Fgcore-2c5466e670c12d50bc7234acc899a0833ffc6282ccb8821ebe0c623fb82ea60d.yml -openapi_spec_hash: a6f0c3323cf195a153b6c5fd3a0d83d4 -config_hash: ee9fe3677a3591bb2fcc219ef6448eb2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gcore%2Fgcore-e8892ba9ca35dd694fd471a17e4ecc95bac4332b7dcbab0ba5e3c5b3f8489f6d.yml +openapi_spec_hash: 25782bc24892e012f8869291dbf22734 +config_hash: 7d1bb312a191f5cc98ba5c35759f8f7c diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d884b12..48611d3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ # Changelog +## 0.37.0 (2026-03-05) + +Full Changelog: [v0.36.0...v0.37.0](https://github.com/G-Core/gcore-python/compare/v0.36.0...v0.37.0) + +### Features + +* add descriptions for all Terraform-enabled resources ([d802ff9](https://github.com/G-Core/gcore-python/commit/d802ff9777ba4f84ec0c7119745ba16d4b3415a3)) +* **api:** aggregated API specs update ([990421e](https://github.com/G-Core/gcore-python/commit/990421e11d813a6808af59712a8c48655cd15b34)) +* **api:** aggregated API specs update ([471fef6](https://github.com/G-Core/gcore-python/commit/471fef6b01e2dac4a54482d376cdb7613b0bc8da)) + + +### Chores + +* **test:** do not count install time for mock server timeout ([fca27a6](https://github.com/G-Core/gcore-python/commit/fca27a6157f527eb6171149db7d6b1133877df2e)) + ## 0.36.0 (2026-03-03) Full Changelog: [v0.35.0...v0.36.0](https://github.com/G-Core/gcore-python/compare/v0.35.0...v0.36.0) diff --git a/pyproject.toml b/pyproject.toml index 045fe512..6f91235f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "gcore" -version = "0.36.0" +version = "0.37.0" description = "The official Python library for the gcore API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/scripts/mock b/scripts/mock index 0b28f6ea..bcf3b392 100755 --- a/scripts/mock +++ b/scripts/mock @@ -21,11 +21,22 @@ echo "==> Starting mock server with URL ${URL}" # Run prism mock on the given spec if [ "$1" == "--daemon" ]; then + # Pre-install the package so the download doesn't eat into the startup timeout + npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism --version + npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log & - # Wait for server to come online + # Wait for server to come online (max 30s) echo -n "Waiting for server" + attempts=0 while ! grep -q "✖ fatal\|Prism is listening" ".prism.log" ; do + attempts=$((attempts + 1)) + if [ "$attempts" -ge 300 ]; then + echo + echo "Timed out waiting for Prism server to start" + cat .prism.log + exit 1 + fi echo -n "." sleep 0.1 done diff --git a/src/gcore/_version.py b/src/gcore/_version.py index 72b7e16a..9d314c83 100644 --- a/src/gcore/_version.py +++ b/src/gcore/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "gcore" -__version__ = "0.36.0" # x-release-please-version +__version__ = "0.37.0" # x-release-please-version diff --git a/src/gcore/resources/cdn/cdn.py b/src/gcore/resources/cdn/cdn.py index 8312906e..1a41c290 100644 --- a/src/gcore/resources/cdn/cdn.py +++ b/src/gcore/resources/cdn/cdn.py @@ -149,6 +149,9 @@ def shields(self) -> ShieldsResource: @cached_property def origin_groups(self) -> OriginGroupsResource: + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ return OriginGroupsResource(self._client) @cached_property @@ -157,10 +160,16 @@ def rule_templates(self) -> RuleTemplatesResource: @cached_property def certificates(self) -> CertificatesResource: + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ return CertificatesResource(self._client) @cached_property def trusted_ca_certificates(self) -> TrustedCaCertificatesResource: + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ return TrustedCaCertificatesResource(self._client) @cached_property @@ -482,6 +491,9 @@ def shields(self) -> AsyncShieldsResource: @cached_property def origin_groups(self) -> AsyncOriginGroupsResource: + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ return AsyncOriginGroupsResource(self._client) @cached_property @@ -490,10 +502,16 @@ def rule_templates(self) -> AsyncRuleTemplatesResource: @cached_property def certificates(self) -> AsyncCertificatesResource: + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ return AsyncCertificatesResource(self._client) @cached_property def trusted_ca_certificates(self) -> AsyncTrustedCaCertificatesResource: + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ return AsyncTrustedCaCertificatesResource(self._client) @cached_property @@ -840,6 +858,9 @@ def shields(self) -> ShieldsResourceWithRawResponse: @cached_property def origin_groups(self) -> OriginGroupsResourceWithRawResponse: + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ return OriginGroupsResourceWithRawResponse(self._cdn.origin_groups) @cached_property @@ -848,10 +869,16 @@ def rule_templates(self) -> RuleTemplatesResourceWithRawResponse: @cached_property def certificates(self) -> CertificatesResourceWithRawResponse: + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ return CertificatesResourceWithRawResponse(self._cdn.certificates) @cached_property def trusted_ca_certificates(self) -> TrustedCaCertificatesResourceWithRawResponse: + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ return TrustedCaCertificatesResourceWithRawResponse(self._cdn.trusted_ca_certificates) @cached_property @@ -951,6 +978,9 @@ def shields(self) -> AsyncShieldsResourceWithRawResponse: @cached_property def origin_groups(self) -> AsyncOriginGroupsResourceWithRawResponse: + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ return AsyncOriginGroupsResourceWithRawResponse(self._cdn.origin_groups) @cached_property @@ -959,10 +989,16 @@ def rule_templates(self) -> AsyncRuleTemplatesResourceWithRawResponse: @cached_property def certificates(self) -> AsyncCertificatesResourceWithRawResponse: + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ return AsyncCertificatesResourceWithRawResponse(self._cdn.certificates) @cached_property def trusted_ca_certificates(self) -> AsyncTrustedCaCertificatesResourceWithRawResponse: + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ return AsyncTrustedCaCertificatesResourceWithRawResponse(self._cdn.trusted_ca_certificates) @cached_property @@ -1062,6 +1098,9 @@ def shields(self) -> ShieldsResourceWithStreamingResponse: @cached_property def origin_groups(self) -> OriginGroupsResourceWithStreamingResponse: + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ return OriginGroupsResourceWithStreamingResponse(self._cdn.origin_groups) @cached_property @@ -1070,10 +1109,16 @@ def rule_templates(self) -> RuleTemplatesResourceWithStreamingResponse: @cached_property def certificates(self) -> CertificatesResourceWithStreamingResponse: + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ return CertificatesResourceWithStreamingResponse(self._cdn.certificates) @cached_property def trusted_ca_certificates(self) -> TrustedCaCertificatesResourceWithStreamingResponse: + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ return TrustedCaCertificatesResourceWithStreamingResponse(self._cdn.trusted_ca_certificates) @cached_property @@ -1173,6 +1218,9 @@ def shields(self) -> AsyncShieldsResourceWithStreamingResponse: @cached_property def origin_groups(self) -> AsyncOriginGroupsResourceWithStreamingResponse: + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ return AsyncOriginGroupsResourceWithStreamingResponse(self._cdn.origin_groups) @cached_property @@ -1181,10 +1229,16 @@ def rule_templates(self) -> AsyncRuleTemplatesResourceWithStreamingResponse: @cached_property def certificates(self) -> AsyncCertificatesResourceWithStreamingResponse: + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ return AsyncCertificatesResourceWithStreamingResponse(self._cdn.certificates) @cached_property def trusted_ca_certificates(self) -> AsyncTrustedCaCertificatesResourceWithStreamingResponse: + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ return AsyncTrustedCaCertificatesResourceWithStreamingResponse(self._cdn.trusted_ca_certificates) @cached_property diff --git a/src/gcore/resources/cdn/cdn_resources/cdn_resources.py b/src/gcore/resources/cdn/cdn_resources/cdn_resources.py index d14795b3..8790b5c5 100644 --- a/src/gcore/resources/cdn/cdn_resources/cdn_resources.py +++ b/src/gcore/resources/cdn/cdn_resources/cdn_resources.py @@ -56,13 +56,7 @@ def shield(self) -> ShieldResource: @cached_property def rules(self) -> RulesResource: """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ return RulesResource(self._client) @@ -973,13 +967,7 @@ def shield(self) -> AsyncShieldResource: @cached_property def rules(self) -> AsyncRulesResource: """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ return AsyncRulesResource(self._client) @@ -1921,13 +1909,7 @@ def shield(self) -> ShieldResourceWithRawResponse: @cached_property def rules(self) -> RulesResourceWithRawResponse: """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ return RulesResourceWithRawResponse(self._cdn_resources.rules) @@ -1971,13 +1953,7 @@ def shield(self) -> AsyncShieldResourceWithRawResponse: @cached_property def rules(self) -> AsyncRulesResourceWithRawResponse: """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ return AsyncRulesResourceWithRawResponse(self._cdn_resources.rules) @@ -2021,13 +1997,7 @@ def shield(self) -> ShieldResourceWithStreamingResponse: @cached_property def rules(self) -> RulesResourceWithStreamingResponse: """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ return RulesResourceWithStreamingResponse(self._cdn_resources.rules) @@ -2071,12 +2041,6 @@ def shield(self) -> AsyncShieldResourceWithStreamingResponse: @cached_property def rules(self) -> AsyncRulesResourceWithStreamingResponse: """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ return AsyncRulesResourceWithStreamingResponse(self._cdn_resources.rules) diff --git a/src/gcore/resources/cdn/cdn_resources/rules.py b/src/gcore/resources/cdn/cdn_resources/rules.py index 7c93a4b1..6378ca6e 100644 --- a/src/gcore/resources/cdn/cdn_resources/rules.py +++ b/src/gcore/resources/cdn/cdn_resources/rules.py @@ -27,13 +27,7 @@ class RulesResource(SyncAPIResource): """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ @cached_property @@ -478,13 +472,7 @@ def replace( class AsyncRulesResource(AsyncAPIResource): """ - Rules allow to set up custom settings for certain file types or paths. - By default, the rule inherits all options values from the related CDN resource. - - Each option in rule settings can be in one of the following states: - - **Inherit** - Option is not added to the rule. Option inherits its value from the CDN resource settings. In this case, the option value is **null**. - - **ON** - Option is added to the rule and enabled. Option values configured in the rule will override values from the CDN resource settings. - - **OFF** - Option is added to the rule and disabled. Option will be turned off. + CDN resource rules set custom caching, delivery, and security options for specific URL patterns or file types. """ @cached_property diff --git a/src/gcore/resources/cdn/certificates.py b/src/gcore/resources/cdn/certificates.py index 5b299f13..51e11024 100644 --- a/src/gcore/resources/cdn/certificates.py +++ b/src/gcore/resources/cdn/certificates.py @@ -31,6 +31,10 @@ class CertificatesResource(SyncAPIResource): + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ + @cached_property def with_raw_response(self) -> CertificatesResourceWithRawResponse: """ @@ -474,6 +478,10 @@ def replace( class AsyncCertificatesResource(AsyncAPIResource): + """ + CDN SSL certificates enable HTTPS content delivery, supporting both uploaded certificates and automated Let's Encrypt provisioning. + """ + @cached_property def with_raw_response(self) -> AsyncCertificatesResourceWithRawResponse: """ diff --git a/src/gcore/resources/cdn/origin_groups.py b/src/gcore/resources/cdn/origin_groups.py index fd8beae5..a1849be4 100644 --- a/src/gcore/resources/cdn/origin_groups.py +++ b/src/gcore/resources/cdn/origin_groups.py @@ -31,6 +31,10 @@ class OriginGroupsResource(SyncAPIResource): + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ + @cached_property def with_raw_response(self) -> OriginGroupsResourceWithRawResponse: """ @@ -706,6 +710,10 @@ def replace( class AsyncOriginGroupsResource(AsyncAPIResource): + """ + CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery. + """ + @cached_property def with_raw_response(self) -> AsyncOriginGroupsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cdn/trusted_ca_certificates.py b/src/gcore/resources/cdn/trusted_ca_certificates.py index 3ac42d0b..1bd4d6dc 100644 --- a/src/gcore/resources/cdn/trusted_ca_certificates.py +++ b/src/gcore/resources/cdn/trusted_ca_certificates.py @@ -27,6 +27,10 @@ class TrustedCaCertificatesResource(SyncAPIResource): + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ + @cached_property def with_raw_response(self) -> TrustedCaCertificatesResourceWithRawResponse: """ @@ -258,6 +262,10 @@ def replace( class AsyncTrustedCaCertificatesResource(AsyncAPIResource): + """ + Trusted CA certificates verify the authenticity of CDN origin servers during HTTPS connections. + """ + @cached_property def with_raw_response(self) -> AsyncTrustedCaCertificatesResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/cloud.py b/src/gcore/resources/cloud/cloud.py index 47a7caab..346a2b06 100644 --- a/src/gcore/resources/cloud/cloud.py +++ b/src/gcore/resources/cloud/cloud.py @@ -243,6 +243,9 @@ class CloudResource(SyncAPIResource): @cached_property def projects(self) -> ProjectsResource: + """ + Projects are organizational units that group cloud resources for access control and billing. + """ return ProjectsResource(self._client) @cached_property @@ -251,6 +254,9 @@ def tasks(self) -> TasksResource: @cached_property def regions(self) -> RegionsResource: + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ return RegionsResource(self._client) @cached_property @@ -259,10 +265,16 @@ def quotas(self) -> QuotasResource: @cached_property def secrets(self) -> SecretsResource: + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ return SecretsResource(self._client) @cached_property def ssh_keys(self) -> SSHKeysResource: + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ return SSHKeysResource(self._client) @cached_property @@ -271,18 +283,30 @@ def ip_ranges(self) -> IPRangesResource: @cached_property def load_balancers(self) -> LoadBalancersResource: + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ return LoadBalancersResource(self._client) @cached_property def reserved_fixed_ips(self) -> ReservedFixedIPsResource: + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ return ReservedFixedIPsResource(self._client) @cached_property def networks(self) -> NetworksResource: + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ return NetworksResource(self._client) @cached_property def volumes(self) -> VolumesResource: + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ return VolumesResource(self._client) @cached_property @@ -295,6 +319,9 @@ def floating_ips(self) -> FloatingIPsResource: @cached_property def security_groups(self) -> SecurityGroupsResource: + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ return SecurityGroupsResource(self._client) @cached_property @@ -308,7 +335,7 @@ def inference(self) -> InferenceResource: @cached_property def placement_groups(self) -> PlacementGroupsResource: """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ return PlacementGroupsResource(self._client) @@ -322,6 +349,9 @@ def registries(self) -> RegistriesResource: @cached_property def file_shares(self) -> FileSharesResource: + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ return FileSharesResource(self._client) @cached_property @@ -338,6 +368,9 @@ def gpu_virtual(self) -> GPUVirtualResource: @cached_property def instances(self) -> InstancesResource: + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ return InstancesResource(self._client) @cached_property @@ -387,6 +420,9 @@ def with_streaming_response(self) -> CloudResourceWithStreamingResponse: class AsyncCloudResource(AsyncAPIResource): @cached_property def projects(self) -> AsyncProjectsResource: + """ + Projects are organizational units that group cloud resources for access control and billing. + """ return AsyncProjectsResource(self._client) @cached_property @@ -395,6 +431,9 @@ def tasks(self) -> AsyncTasksResource: @cached_property def regions(self) -> AsyncRegionsResource: + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ return AsyncRegionsResource(self._client) @cached_property @@ -403,10 +442,16 @@ def quotas(self) -> AsyncQuotasResource: @cached_property def secrets(self) -> AsyncSecretsResource: + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ return AsyncSecretsResource(self._client) @cached_property def ssh_keys(self) -> AsyncSSHKeysResource: + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ return AsyncSSHKeysResource(self._client) @cached_property @@ -415,18 +460,30 @@ def ip_ranges(self) -> AsyncIPRangesResource: @cached_property def load_balancers(self) -> AsyncLoadBalancersResource: + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ return AsyncLoadBalancersResource(self._client) @cached_property def reserved_fixed_ips(self) -> AsyncReservedFixedIPsResource: + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ return AsyncReservedFixedIPsResource(self._client) @cached_property def networks(self) -> AsyncNetworksResource: + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ return AsyncNetworksResource(self._client) @cached_property def volumes(self) -> AsyncVolumesResource: + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ return AsyncVolumesResource(self._client) @cached_property @@ -439,6 +496,9 @@ def floating_ips(self) -> AsyncFloatingIPsResource: @cached_property def security_groups(self) -> AsyncSecurityGroupsResource: + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ return AsyncSecurityGroupsResource(self._client) @cached_property @@ -452,7 +512,7 @@ def inference(self) -> AsyncInferenceResource: @cached_property def placement_groups(self) -> AsyncPlacementGroupsResource: """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ return AsyncPlacementGroupsResource(self._client) @@ -466,6 +526,9 @@ def registries(self) -> AsyncRegistriesResource: @cached_property def file_shares(self) -> AsyncFileSharesResource: + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ return AsyncFileSharesResource(self._client) @cached_property @@ -482,6 +545,9 @@ def gpu_virtual(self) -> AsyncGPUVirtualResource: @cached_property def instances(self) -> AsyncInstancesResource: + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ return AsyncInstancesResource(self._client) @cached_property @@ -534,6 +600,9 @@ def __init__(self, cloud: CloudResource) -> None: @cached_property def projects(self) -> ProjectsResourceWithRawResponse: + """ + Projects are organizational units that group cloud resources for access control and billing. + """ return ProjectsResourceWithRawResponse(self._cloud.projects) @cached_property @@ -542,6 +611,9 @@ def tasks(self) -> TasksResourceWithRawResponse: @cached_property def regions(self) -> RegionsResourceWithRawResponse: + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ return RegionsResourceWithRawResponse(self._cloud.regions) @cached_property @@ -550,10 +622,16 @@ def quotas(self) -> QuotasResourceWithRawResponse: @cached_property def secrets(self) -> SecretsResourceWithRawResponse: + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ return SecretsResourceWithRawResponse(self._cloud.secrets) @cached_property def ssh_keys(self) -> SSHKeysResourceWithRawResponse: + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ return SSHKeysResourceWithRawResponse(self._cloud.ssh_keys) @cached_property @@ -562,18 +640,30 @@ def ip_ranges(self) -> IPRangesResourceWithRawResponse: @cached_property def load_balancers(self) -> LoadBalancersResourceWithRawResponse: + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ return LoadBalancersResourceWithRawResponse(self._cloud.load_balancers) @cached_property def reserved_fixed_ips(self) -> ReservedFixedIPsResourceWithRawResponse: + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ return ReservedFixedIPsResourceWithRawResponse(self._cloud.reserved_fixed_ips) @cached_property def networks(self) -> NetworksResourceWithRawResponse: + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ return NetworksResourceWithRawResponse(self._cloud.networks) @cached_property def volumes(self) -> VolumesResourceWithRawResponse: + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ return VolumesResourceWithRawResponse(self._cloud.volumes) @cached_property @@ -586,6 +676,9 @@ def floating_ips(self) -> FloatingIPsResourceWithRawResponse: @cached_property def security_groups(self) -> SecurityGroupsResourceWithRawResponse: + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ return SecurityGroupsResourceWithRawResponse(self._cloud.security_groups) @cached_property @@ -599,7 +692,7 @@ def inference(self) -> InferenceResourceWithRawResponse: @cached_property def placement_groups(self) -> PlacementGroupsResourceWithRawResponse: """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ return PlacementGroupsResourceWithRawResponse(self._cloud.placement_groups) @@ -613,6 +706,9 @@ def registries(self) -> RegistriesResourceWithRawResponse: @cached_property def file_shares(self) -> FileSharesResourceWithRawResponse: + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ return FileSharesResourceWithRawResponse(self._cloud.file_shares) @cached_property @@ -629,6 +725,9 @@ def gpu_virtual(self) -> GPUVirtualResourceWithRawResponse: @cached_property def instances(self) -> InstancesResourceWithRawResponse: + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ return InstancesResourceWithRawResponse(self._cloud.instances) @cached_property @@ -662,6 +761,9 @@ def __init__(self, cloud: AsyncCloudResource) -> None: @cached_property def projects(self) -> AsyncProjectsResourceWithRawResponse: + """ + Projects are organizational units that group cloud resources for access control and billing. + """ return AsyncProjectsResourceWithRawResponse(self._cloud.projects) @cached_property @@ -670,6 +772,9 @@ def tasks(self) -> AsyncTasksResourceWithRawResponse: @cached_property def regions(self) -> AsyncRegionsResourceWithRawResponse: + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ return AsyncRegionsResourceWithRawResponse(self._cloud.regions) @cached_property @@ -678,10 +783,16 @@ def quotas(self) -> AsyncQuotasResourceWithRawResponse: @cached_property def secrets(self) -> AsyncSecretsResourceWithRawResponse: + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ return AsyncSecretsResourceWithRawResponse(self._cloud.secrets) @cached_property def ssh_keys(self) -> AsyncSSHKeysResourceWithRawResponse: + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ return AsyncSSHKeysResourceWithRawResponse(self._cloud.ssh_keys) @cached_property @@ -690,18 +801,30 @@ def ip_ranges(self) -> AsyncIPRangesResourceWithRawResponse: @cached_property def load_balancers(self) -> AsyncLoadBalancersResourceWithRawResponse: + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ return AsyncLoadBalancersResourceWithRawResponse(self._cloud.load_balancers) @cached_property def reserved_fixed_ips(self) -> AsyncReservedFixedIPsResourceWithRawResponse: + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ return AsyncReservedFixedIPsResourceWithRawResponse(self._cloud.reserved_fixed_ips) @cached_property def networks(self) -> AsyncNetworksResourceWithRawResponse: + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ return AsyncNetworksResourceWithRawResponse(self._cloud.networks) @cached_property def volumes(self) -> AsyncVolumesResourceWithRawResponse: + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ return AsyncVolumesResourceWithRawResponse(self._cloud.volumes) @cached_property @@ -714,6 +837,9 @@ def floating_ips(self) -> AsyncFloatingIPsResourceWithRawResponse: @cached_property def security_groups(self) -> AsyncSecurityGroupsResourceWithRawResponse: + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ return AsyncSecurityGroupsResourceWithRawResponse(self._cloud.security_groups) @cached_property @@ -727,7 +853,7 @@ def inference(self) -> AsyncInferenceResourceWithRawResponse: @cached_property def placement_groups(self) -> AsyncPlacementGroupsResourceWithRawResponse: """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ return AsyncPlacementGroupsResourceWithRawResponse(self._cloud.placement_groups) @@ -741,6 +867,9 @@ def registries(self) -> AsyncRegistriesResourceWithRawResponse: @cached_property def file_shares(self) -> AsyncFileSharesResourceWithRawResponse: + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ return AsyncFileSharesResourceWithRawResponse(self._cloud.file_shares) @cached_property @@ -757,6 +886,9 @@ def gpu_virtual(self) -> AsyncGPUVirtualResourceWithRawResponse: @cached_property def instances(self) -> AsyncInstancesResourceWithRawResponse: + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ return AsyncInstancesResourceWithRawResponse(self._cloud.instances) @cached_property @@ -790,6 +922,9 @@ def __init__(self, cloud: CloudResource) -> None: @cached_property def projects(self) -> ProjectsResourceWithStreamingResponse: + """ + Projects are organizational units that group cloud resources for access control and billing. + """ return ProjectsResourceWithStreamingResponse(self._cloud.projects) @cached_property @@ -798,6 +933,9 @@ def tasks(self) -> TasksResourceWithStreamingResponse: @cached_property def regions(self) -> RegionsResourceWithStreamingResponse: + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ return RegionsResourceWithStreamingResponse(self._cloud.regions) @cached_property @@ -806,10 +944,16 @@ def quotas(self) -> QuotasResourceWithStreamingResponse: @cached_property def secrets(self) -> SecretsResourceWithStreamingResponse: + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ return SecretsResourceWithStreamingResponse(self._cloud.secrets) @cached_property def ssh_keys(self) -> SSHKeysResourceWithStreamingResponse: + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ return SSHKeysResourceWithStreamingResponse(self._cloud.ssh_keys) @cached_property @@ -818,18 +962,30 @@ def ip_ranges(self) -> IPRangesResourceWithStreamingResponse: @cached_property def load_balancers(self) -> LoadBalancersResourceWithStreamingResponse: + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ return LoadBalancersResourceWithStreamingResponse(self._cloud.load_balancers) @cached_property def reserved_fixed_ips(self) -> ReservedFixedIPsResourceWithStreamingResponse: + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ return ReservedFixedIPsResourceWithStreamingResponse(self._cloud.reserved_fixed_ips) @cached_property def networks(self) -> NetworksResourceWithStreamingResponse: + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ return NetworksResourceWithStreamingResponse(self._cloud.networks) @cached_property def volumes(self) -> VolumesResourceWithStreamingResponse: + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ return VolumesResourceWithStreamingResponse(self._cloud.volumes) @cached_property @@ -842,6 +998,9 @@ def floating_ips(self) -> FloatingIPsResourceWithStreamingResponse: @cached_property def security_groups(self) -> SecurityGroupsResourceWithStreamingResponse: + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ return SecurityGroupsResourceWithStreamingResponse(self._cloud.security_groups) @cached_property @@ -855,7 +1014,7 @@ def inference(self) -> InferenceResourceWithStreamingResponse: @cached_property def placement_groups(self) -> PlacementGroupsResourceWithStreamingResponse: """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ return PlacementGroupsResourceWithStreamingResponse(self._cloud.placement_groups) @@ -869,6 +1028,9 @@ def registries(self) -> RegistriesResourceWithStreamingResponse: @cached_property def file_shares(self) -> FileSharesResourceWithStreamingResponse: + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ return FileSharesResourceWithStreamingResponse(self._cloud.file_shares) @cached_property @@ -885,6 +1047,9 @@ def gpu_virtual(self) -> GPUVirtualResourceWithStreamingResponse: @cached_property def instances(self) -> InstancesResourceWithStreamingResponse: + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ return InstancesResourceWithStreamingResponse(self._cloud.instances) @cached_property @@ -918,6 +1083,9 @@ def __init__(self, cloud: AsyncCloudResource) -> None: @cached_property def projects(self) -> AsyncProjectsResourceWithStreamingResponse: + """ + Projects are organizational units that group cloud resources for access control and billing. + """ return AsyncProjectsResourceWithStreamingResponse(self._cloud.projects) @cached_property @@ -926,6 +1094,9 @@ def tasks(self) -> AsyncTasksResourceWithStreamingResponse: @cached_property def regions(self) -> AsyncRegionsResourceWithStreamingResponse: + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ return AsyncRegionsResourceWithStreamingResponse(self._cloud.regions) @cached_property @@ -934,10 +1105,16 @@ def quotas(self) -> AsyncQuotasResourceWithStreamingResponse: @cached_property def secrets(self) -> AsyncSecretsResourceWithStreamingResponse: + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ return AsyncSecretsResourceWithStreamingResponse(self._cloud.secrets) @cached_property def ssh_keys(self) -> AsyncSSHKeysResourceWithStreamingResponse: + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ return AsyncSSHKeysResourceWithStreamingResponse(self._cloud.ssh_keys) @cached_property @@ -946,18 +1123,30 @@ def ip_ranges(self) -> AsyncIPRangesResourceWithStreamingResponse: @cached_property def load_balancers(self) -> AsyncLoadBalancersResourceWithStreamingResponse: + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ return AsyncLoadBalancersResourceWithStreamingResponse(self._cloud.load_balancers) @cached_property def reserved_fixed_ips(self) -> AsyncReservedFixedIPsResourceWithStreamingResponse: + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ return AsyncReservedFixedIPsResourceWithStreamingResponse(self._cloud.reserved_fixed_ips) @cached_property def networks(self) -> AsyncNetworksResourceWithStreamingResponse: + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ return AsyncNetworksResourceWithStreamingResponse(self._cloud.networks) @cached_property def volumes(self) -> AsyncVolumesResourceWithStreamingResponse: + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ return AsyncVolumesResourceWithStreamingResponse(self._cloud.volumes) @cached_property @@ -970,6 +1159,9 @@ def floating_ips(self) -> AsyncFloatingIPsResourceWithStreamingResponse: @cached_property def security_groups(self) -> AsyncSecurityGroupsResourceWithStreamingResponse: + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ return AsyncSecurityGroupsResourceWithStreamingResponse(self._cloud.security_groups) @cached_property @@ -983,7 +1175,7 @@ def inference(self) -> AsyncInferenceResourceWithStreamingResponse: @cached_property def placement_groups(self) -> AsyncPlacementGroupsResourceWithStreamingResponse: """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ return AsyncPlacementGroupsResourceWithStreamingResponse(self._cloud.placement_groups) @@ -997,6 +1189,9 @@ def registries(self) -> AsyncRegistriesResourceWithStreamingResponse: @cached_property def file_shares(self) -> AsyncFileSharesResourceWithStreamingResponse: + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ return AsyncFileSharesResourceWithStreamingResponse(self._cloud.file_shares) @cached_property @@ -1013,6 +1208,9 @@ def gpu_virtual(self) -> AsyncGPUVirtualResourceWithStreamingResponse: @cached_property def instances(self) -> AsyncInstancesResourceWithStreamingResponse: + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ return AsyncInstancesResourceWithStreamingResponse(self._cloud.instances) @cached_property diff --git a/src/gcore/resources/cloud/file_shares/access_rules.py b/src/gcore/resources/cloud/file_shares/access_rules.py index 6750a7c5..259285ef 100644 --- a/src/gcore/resources/cloud/file_shares/access_rules.py +++ b/src/gcore/resources/cloud/file_shares/access_rules.py @@ -25,6 +25,10 @@ class AccessRulesResource(SyncAPIResource): + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ + @cached_property def with_raw_response(self) -> AccessRulesResourceWithRawResponse: """ @@ -200,6 +204,10 @@ def delete( class AsyncAccessRulesResource(AsyncAPIResource): + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ + @cached_property def with_raw_response(self) -> AsyncAccessRulesResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/file_shares/file_shares.py b/src/gcore/resources/cloud/file_shares/file_shares.py index 7b5cdea2..fcf861eb 100644 --- a/src/gcore/resources/cloud/file_shares/file_shares.py +++ b/src/gcore/resources/cloud/file_shares/file_shares.py @@ -41,8 +41,15 @@ class FileSharesResource(SyncAPIResource): + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ + @cached_property def access_rules(self) -> AccessRulesResource: + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ return AccessRulesResource(self._client) @cached_property @@ -566,8 +573,15 @@ def resize( class AsyncFileSharesResource(AsyncAPIResource): + """ + File shares provide NFS-based shared storage that can be mounted by virtual machines and Kubernetes clusters for persistent data. + """ + @cached_property def access_rules(self) -> AsyncAccessRulesResource: + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ return AsyncAccessRulesResource(self._client) @cached_property @@ -1118,6 +1132,9 @@ def __init__(self, file_shares: FileSharesResource) -> None: @cached_property def access_rules(self) -> AccessRulesResourceWithRawResponse: + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ return AccessRulesResourceWithRawResponse(self._file_shares.access_rules) @@ -1149,6 +1166,9 @@ def __init__(self, file_shares: AsyncFileSharesResource) -> None: @cached_property def access_rules(self) -> AsyncAccessRulesResourceWithRawResponse: + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ return AsyncAccessRulesResourceWithRawResponse(self._file_shares.access_rules) @@ -1180,6 +1200,9 @@ def __init__(self, file_shares: FileSharesResource) -> None: @cached_property def access_rules(self) -> AccessRulesResourceWithStreamingResponse: + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ return AccessRulesResourceWithStreamingResponse(self._file_shares.access_rules) @@ -1211,4 +1234,7 @@ def __init__(self, file_shares: AsyncFileSharesResource) -> None: @cached_property def access_rules(self) -> AsyncAccessRulesResourceWithStreamingResponse: + """ + File share access rules control which IP addresses can mount a file share and their permissions (read-only or read-write). + """ return AsyncAccessRulesResourceWithStreamingResponse(self._file_shares.access_rules) diff --git a/src/gcore/resources/cloud/gpu_baremetal/clusters/clusters.py b/src/gcore/resources/cloud/gpu_baremetal/clusters/clusters.py index 0ea1d06c..c6f18d25 100644 --- a/src/gcore/resources/cloud/gpu_baremetal/clusters/clusters.py +++ b/src/gcore/resources/cloud/gpu_baremetal/clusters/clusters.py @@ -82,6 +82,7 @@ def flavors(self) -> FlavorsResource: @cached_property def images(self) -> ImagesResource: + """GPU bare metal images are custom boot images for bare metal GPU servers.""" return ImagesResource(self._client) @cached_property @@ -847,6 +848,7 @@ def flavors(self) -> AsyncFlavorsResource: @cached_property def images(self) -> AsyncImagesResource: + """GPU bare metal images are custom boot images for bare metal GPU servers.""" return AsyncImagesResource(self._client) @cached_property @@ -1657,6 +1659,7 @@ def flavors(self) -> FlavorsResourceWithRawResponse: @cached_property def images(self) -> ImagesResourceWithRawResponse: + """GPU bare metal images are custom boot images for bare metal GPU servers.""" return ImagesResourceWithRawResponse(self._clusters.images) @@ -1718,6 +1721,7 @@ def flavors(self) -> AsyncFlavorsResourceWithRawResponse: @cached_property def images(self) -> AsyncImagesResourceWithRawResponse: + """GPU bare metal images are custom boot images for bare metal GPU servers.""" return AsyncImagesResourceWithRawResponse(self._clusters.images) @@ -1779,6 +1783,7 @@ def flavors(self) -> FlavorsResourceWithStreamingResponse: @cached_property def images(self) -> ImagesResourceWithStreamingResponse: + """GPU bare metal images are custom boot images for bare metal GPU servers.""" return ImagesResourceWithStreamingResponse(self._clusters.images) @@ -1840,4 +1845,5 @@ def flavors(self) -> AsyncFlavorsResourceWithStreamingResponse: @cached_property def images(self) -> AsyncImagesResourceWithStreamingResponse: + """GPU bare metal images are custom boot images for bare metal GPU servers.""" return AsyncImagesResourceWithStreamingResponse(self._clusters.images) diff --git a/src/gcore/resources/cloud/gpu_baremetal/clusters/images.py b/src/gcore/resources/cloud/gpu_baremetal/clusters/images.py index dee06b23..6a291c24 100644 --- a/src/gcore/resources/cloud/gpu_baremetal/clusters/images.py +++ b/src/gcore/resources/cloud/gpu_baremetal/clusters/images.py @@ -27,6 +27,8 @@ class ImagesResource(SyncAPIResource): + """GPU bare metal images are custom boot images for bare metal GPU servers.""" + @cached_property def with_raw_response(self) -> ImagesResourceWithRawResponse: """ @@ -375,6 +377,8 @@ def upload_and_poll( class AsyncImagesResource(AsyncAPIResource): + """GPU bare metal images are custom boot images for bare metal GPU servers.""" + @cached_property def with_raw_response(self) -> AsyncImagesResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/gpu_virtual/clusters/clusters.py b/src/gcore/resources/cloud/gpu_virtual/clusters/clusters.py index 486048b5..f141c5b6 100644 --- a/src/gcore/resources/cloud/gpu_virtual/clusters/clusters.py +++ b/src/gcore/resources/cloud/gpu_virtual/clusters/clusters.py @@ -74,6 +74,10 @@ class ClustersResource(SyncAPIResource): + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ + @cached_property def servers(self) -> ServersResource: return ServersResource(self._client) @@ -92,6 +96,7 @@ def flavors(self) -> FlavorsResource: @cached_property def images(self) -> ImagesResource: + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" return ImagesResource(self._client) @cached_property @@ -719,6 +724,10 @@ def get( class AsyncClustersResource(AsyncAPIResource): + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ + @cached_property def servers(self) -> AsyncServersResource: return AsyncServersResource(self._client) @@ -737,6 +746,7 @@ def flavors(self) -> AsyncFlavorsResource: @cached_property def images(self) -> AsyncImagesResource: + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" return AsyncImagesResource(self._client) @cached_property @@ -1404,6 +1414,7 @@ def flavors(self) -> FlavorsResourceWithRawResponse: @cached_property def images(self) -> ImagesResourceWithRawResponse: + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" return ImagesResourceWithRawResponse(self._clusters.images) @@ -1448,6 +1459,7 @@ def flavors(self) -> AsyncFlavorsResourceWithRawResponse: @cached_property def images(self) -> AsyncImagesResourceWithRawResponse: + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" return AsyncImagesResourceWithRawResponse(self._clusters.images) @@ -1492,6 +1504,7 @@ def flavors(self) -> FlavorsResourceWithStreamingResponse: @cached_property def images(self) -> ImagesResourceWithStreamingResponse: + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" return ImagesResourceWithStreamingResponse(self._clusters.images) @@ -1536,4 +1549,5 @@ def flavors(self) -> AsyncFlavorsResourceWithStreamingResponse: @cached_property def images(self) -> AsyncImagesResourceWithStreamingResponse: + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" return AsyncImagesResourceWithStreamingResponse(self._clusters.images) diff --git a/src/gcore/resources/cloud/gpu_virtual/clusters/images.py b/src/gcore/resources/cloud/gpu_virtual/clusters/images.py index 9c7d1472..b48be175 100644 --- a/src/gcore/resources/cloud/gpu_virtual/clusters/images.py +++ b/src/gcore/resources/cloud/gpu_virtual/clusters/images.py @@ -27,6 +27,8 @@ class ImagesResource(SyncAPIResource): + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" + @cached_property def with_raw_response(self) -> ImagesResourceWithRawResponse: """ @@ -269,6 +271,8 @@ def upload( class AsyncImagesResource(AsyncAPIResource): + """GPU virtual images are custom boot images for virtual GPU cluster instances.""" + @cached_property def with_raw_response(self) -> AsyncImagesResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/gpu_virtual/gpu_virtual.py b/src/gcore/resources/cloud/gpu_virtual/gpu_virtual.py index 959b2156..8c45ab38 100644 --- a/src/gcore/resources/cloud/gpu_virtual/gpu_virtual.py +++ b/src/gcore/resources/cloud/gpu_virtual/gpu_virtual.py @@ -19,6 +19,9 @@ class GPUVirtualResource(SyncAPIResource): @cached_property def clusters(self) -> ClustersResource: + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ return ClustersResource(self._client) @cached_property @@ -44,6 +47,9 @@ def with_streaming_response(self) -> GPUVirtualResourceWithStreamingResponse: class AsyncGPUVirtualResource(AsyncAPIResource): @cached_property def clusters(self) -> AsyncClustersResource: + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ return AsyncClustersResource(self._client) @cached_property @@ -72,6 +78,9 @@ def __init__(self, gpu_virtual: GPUVirtualResource) -> None: @cached_property def clusters(self) -> ClustersResourceWithRawResponse: + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ return ClustersResourceWithRawResponse(self._gpu_virtual.clusters) @@ -81,6 +90,9 @@ def __init__(self, gpu_virtual: AsyncGPUVirtualResource) -> None: @cached_property def clusters(self) -> AsyncClustersResourceWithRawResponse: + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ return AsyncClustersResourceWithRawResponse(self._gpu_virtual.clusters) @@ -90,6 +102,9 @@ def __init__(self, gpu_virtual: GPUVirtualResource) -> None: @cached_property def clusters(self) -> ClustersResourceWithStreamingResponse: + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ return ClustersResourceWithStreamingResponse(self._gpu_virtual.clusters) @@ -99,4 +114,7 @@ def __init__(self, gpu_virtual: AsyncGPUVirtualResource) -> None: @cached_property def clusters(self) -> AsyncClustersResourceWithStreamingResponse: + """ + GPU virtual clusters provide managed virtual GPU servers with auto-scaling for parallel computation workloads. + """ return AsyncClustersResourceWithStreamingResponse(self._gpu_virtual.clusters) diff --git a/src/gcore/resources/cloud/inference/deployments/deployments.py b/src/gcore/resources/cloud/inference/deployments/deployments.py index 2d1488c5..9a32daf3 100644 --- a/src/gcore/resources/cloud/inference/deployments/deployments.py +++ b/src/gcore/resources/cloud/inference/deployments/deployments.py @@ -36,6 +36,10 @@ class DeploymentsResource(SyncAPIResource): + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ + @cached_property def logs(self) -> LogsResource: return LogsResource(self._client) @@ -735,6 +739,10 @@ def delete_and_poll( class AsyncDeploymentsResource(AsyncAPIResource): + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ + @cached_property def logs(self) -> AsyncLogsResource: return AsyncLogsResource(self._client) diff --git a/src/gcore/resources/cloud/inference/inference.py b/src/gcore/resources/cloud/inference/inference.py index 86dd2f3c..941b8e83 100644 --- a/src/gcore/resources/cloud/inference/inference.py +++ b/src/gcore/resources/cloud/inference/inference.py @@ -74,14 +74,23 @@ def flavors(self) -> FlavorsResource: @cached_property def deployments(self) -> DeploymentsResource: + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ return DeploymentsResource(self._client) @cached_property def registry_credentials(self) -> RegistryCredentialsResource: + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ return RegistryCredentialsResource(self._client) @cached_property def secrets(self) -> SecretsResource: + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ return SecretsResource(self._client) @cached_property @@ -138,14 +147,23 @@ def flavors(self) -> AsyncFlavorsResource: @cached_property def deployments(self) -> AsyncDeploymentsResource: + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ return AsyncDeploymentsResource(self._client) @cached_property def registry_credentials(self) -> AsyncRegistryCredentialsResource: + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ return AsyncRegistryCredentialsResource(self._client) @cached_property def secrets(self) -> AsyncSecretsResource: + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ return AsyncSecretsResource(self._client) @cached_property @@ -209,14 +227,23 @@ def flavors(self) -> FlavorsResourceWithRawResponse: @cached_property def deployments(self) -> DeploymentsResourceWithRawResponse: + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ return DeploymentsResourceWithRawResponse(self._inference.deployments) @cached_property def registry_credentials(self) -> RegistryCredentialsResourceWithRawResponse: + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ return RegistryCredentialsResourceWithRawResponse(self._inference.registry_credentials) @cached_property def secrets(self) -> SecretsResourceWithRawResponse: + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ return SecretsResourceWithRawResponse(self._inference.secrets) @cached_property @@ -242,14 +269,23 @@ def flavors(self) -> AsyncFlavorsResourceWithRawResponse: @cached_property def deployments(self) -> AsyncDeploymentsResourceWithRawResponse: + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ return AsyncDeploymentsResourceWithRawResponse(self._inference.deployments) @cached_property def registry_credentials(self) -> AsyncRegistryCredentialsResourceWithRawResponse: + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ return AsyncRegistryCredentialsResourceWithRawResponse(self._inference.registry_credentials) @cached_property def secrets(self) -> AsyncSecretsResourceWithRawResponse: + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ return AsyncSecretsResourceWithRawResponse(self._inference.secrets) @cached_property @@ -275,14 +311,23 @@ def flavors(self) -> FlavorsResourceWithStreamingResponse: @cached_property def deployments(self) -> DeploymentsResourceWithStreamingResponse: + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ return DeploymentsResourceWithStreamingResponse(self._inference.deployments) @cached_property def registry_credentials(self) -> RegistryCredentialsResourceWithStreamingResponse: + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ return RegistryCredentialsResourceWithStreamingResponse(self._inference.registry_credentials) @cached_property def secrets(self) -> SecretsResourceWithStreamingResponse: + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ return SecretsResourceWithStreamingResponse(self._inference.secrets) @cached_property @@ -308,14 +353,23 @@ def flavors(self) -> AsyncFlavorsResourceWithStreamingResponse: @cached_property def deployments(self) -> AsyncDeploymentsResourceWithStreamingResponse: + """ + Inference deployments run containerized ML models with configurable scaling, health probes, and GPU flavors. + """ return AsyncDeploymentsResourceWithStreamingResponse(self._inference.deployments) @cached_property def registry_credentials(self) -> AsyncRegistryCredentialsResourceWithStreamingResponse: + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ return AsyncRegistryCredentialsResourceWithStreamingResponse(self._inference.registry_credentials) @cached_property def secrets(self) -> AsyncSecretsResourceWithStreamingResponse: + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ return AsyncSecretsResourceWithStreamingResponse(self._inference.secrets) @cached_property diff --git a/src/gcore/resources/cloud/inference/registry_credentials.py b/src/gcore/resources/cloud/inference/registry_credentials.py index c34dfc0a..46cee6d2 100644 --- a/src/gcore/resources/cloud/inference/registry_credentials.py +++ b/src/gcore/resources/cloud/inference/registry_credentials.py @@ -27,6 +27,10 @@ class RegistryCredentialsResource(SyncAPIResource): + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ + @cached_property def with_raw_response(self) -> RegistryCredentialsResourceWithRawResponse: """ @@ -295,6 +299,10 @@ def replace( class AsyncRegistryCredentialsResource(AsyncAPIResource): + """ + Registry credentials store authentication details for private container registries used by inference deployments. + """ + @cached_property def with_raw_response(self) -> AsyncRegistryCredentialsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/inference/secrets.py b/src/gcore/resources/cloud/inference/secrets.py index 6b168d22..7d51418e 100644 --- a/src/gcore/resources/cloud/inference/secrets.py +++ b/src/gcore/resources/cloud/inference/secrets.py @@ -23,6 +23,10 @@ class SecretsResource(SyncAPIResource): + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ + @cached_property def with_raw_response(self) -> SecretsResourceWithRawResponse: """ @@ -284,6 +288,10 @@ def replace( class AsyncSecretsResource(AsyncAPIResource): + """ + Inference secrets store sensitive values such as AWS credentials used for SQS-based autoscaling triggers in deployments. + """ + @cached_property def with_raw_response(self) -> AsyncSecretsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/instances/flavors.py b/src/gcore/resources/cloud/instances/flavors.py index 23ba0073..3263eef3 100644 --- a/src/gcore/resources/cloud/instances/flavors.py +++ b/src/gcore/resources/cloud/instances/flavors.py @@ -22,6 +22,10 @@ class FlavorsResource(SyncAPIResource): + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ + @cached_property def with_raw_response(self) -> FlavorsResourceWithRawResponse: """ @@ -106,6 +110,10 @@ def list( class AsyncFlavorsResource(AsyncAPIResource): + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ + @cached_property def with_raw_response(self) -> AsyncFlavorsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/instances/images.py b/src/gcore/resources/cloud/instances/images.py index 8737a631..c1cd30cb 100644 --- a/src/gcore/resources/cloud/instances/images.py +++ b/src/gcore/resources/cloud/instances/images.py @@ -34,6 +34,10 @@ class ImagesResource(SyncAPIResource): + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ + @cached_property def with_raw_response(self) -> ImagesResourceWithRawResponse: """ @@ -635,6 +639,10 @@ def upload_and_poll( class AsyncImagesResource(AsyncAPIResource): + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ + @cached_property def with_raw_response(self) -> AsyncImagesResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/instances/instances.py b/src/gcore/resources/cloud/instances/instances.py index 2c83bbae..73fcef9b 100644 --- a/src/gcore/resources/cloud/instances/instances.py +++ b/src/gcore/resources/cloud/instances/instances.py @@ -74,8 +74,15 @@ class InstancesResource(SyncAPIResource): + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ + @cached_property def flavors(self) -> FlavorsResource: + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ return FlavorsResource(self._client) @cached_property @@ -84,6 +91,9 @@ def interfaces(self) -> InterfacesResource: @cached_property def images(self) -> ImagesResource: + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ return ImagesResource(self._client) @cached_property @@ -1493,8 +1503,15 @@ def unassign_security_group( class AsyncInstancesResource(AsyncAPIResource): + """ + Instances are cloud virtual machines with configurable CPU, memory, storage, and networking, supporting various operating systems and workloads. + """ + @cached_property def flavors(self) -> AsyncFlavorsResource: + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ return AsyncFlavorsResource(self._client) @cached_property @@ -1503,6 +1520,9 @@ def interfaces(self) -> AsyncInterfacesResource: @cached_property def images(self) -> AsyncImagesResource: + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ return AsyncImagesResource(self._client) @cached_property @@ -2978,6 +2998,9 @@ def __init__(self, instances: InstancesResource) -> None: @cached_property def flavors(self) -> FlavorsResourceWithRawResponse: + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ return FlavorsResourceWithRawResponse(self._instances.flavors) @cached_property @@ -2986,6 +3009,9 @@ def interfaces(self) -> InterfacesResourceWithRawResponse: @cached_property def images(self) -> ImagesResourceWithRawResponse: + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ return ImagesResourceWithRawResponse(self._instances.images) @cached_property @@ -3060,6 +3086,9 @@ def __init__(self, instances: AsyncInstancesResource) -> None: @cached_property def flavors(self) -> AsyncFlavorsResourceWithRawResponse: + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ return AsyncFlavorsResourceWithRawResponse(self._instances.flavors) @cached_property @@ -3068,6 +3097,9 @@ def interfaces(self) -> AsyncInterfacesResourceWithRawResponse: @cached_property def images(self) -> AsyncImagesResourceWithRawResponse: + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ return AsyncImagesResourceWithRawResponse(self._instances.images) @cached_property @@ -3142,6 +3174,9 @@ def __init__(self, instances: InstancesResource) -> None: @cached_property def flavors(self) -> FlavorsResourceWithStreamingResponse: + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ return FlavorsResourceWithStreamingResponse(self._instances.flavors) @cached_property @@ -3150,6 +3185,9 @@ def interfaces(self) -> InterfacesResourceWithStreamingResponse: @cached_property def images(self) -> ImagesResourceWithStreamingResponse: + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ return ImagesResourceWithStreamingResponse(self._instances.images) @cached_property @@ -3224,6 +3262,9 @@ def __init__(self, instances: AsyncInstancesResource) -> None: @cached_property def flavors(self) -> AsyncFlavorsResourceWithStreamingResponse: + """ + Instance flavors define available CPU, memory, and disk configurations for creating cloud instances. + """ return AsyncFlavorsResourceWithStreamingResponse(self._instances.flavors) @cached_property @@ -3232,6 +3273,9 @@ def interfaces(self) -> AsyncInterfacesResourceWithStreamingResponse: @cached_property def images(self) -> AsyncImagesResourceWithStreamingResponse: + """ + Instance images are operating system images (public, private, or shared) used to boot cloud instances. + """ return AsyncImagesResourceWithStreamingResponse(self._instances.images) @cached_property diff --git a/src/gcore/resources/cloud/k8s/clusters/clusters.py b/src/gcore/resources/cloud/k8s/clusters/clusters.py index ca2c3529..87f60248 100644 --- a/src/gcore/resources/cloud/k8s/clusters/clusters.py +++ b/src/gcore/resources/cloud/k8s/clusters/clusters.py @@ -50,6 +50,10 @@ class ClustersResource(SyncAPIResource): + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ + @cached_property def nodes(self) -> NodesResource: return NodesResource(self._client) @@ -703,6 +707,10 @@ def upgrade( class AsyncClustersResource(AsyncAPIResource): + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ + @cached_property def nodes(self) -> AsyncNodesResource: return AsyncNodesResource(self._client) diff --git a/src/gcore/resources/cloud/k8s/k8s.py b/src/gcore/resources/cloud/k8s/k8s.py index 7a31e244..8cbef33f 100644 --- a/src/gcore/resources/cloud/k8s/k8s.py +++ b/src/gcore/resources/cloud/k8s/k8s.py @@ -42,6 +42,9 @@ def flavors(self) -> FlavorsResource: @cached_property def clusters(self) -> ClustersResource: + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ return ClustersResource(self._client) @cached_property @@ -111,6 +114,9 @@ def flavors(self) -> AsyncFlavorsResource: @cached_property def clusters(self) -> AsyncClustersResource: + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ return AsyncClustersResource(self._client) @cached_property @@ -187,6 +193,9 @@ def flavors(self) -> FlavorsResourceWithRawResponse: @cached_property def clusters(self) -> ClustersResourceWithRawResponse: + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ return ClustersResourceWithRawResponse(self._k8s.clusters) @@ -204,6 +213,9 @@ def flavors(self) -> AsyncFlavorsResourceWithRawResponse: @cached_property def clusters(self) -> AsyncClustersResourceWithRawResponse: + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ return AsyncClustersResourceWithRawResponse(self._k8s.clusters) @@ -221,6 +233,9 @@ def flavors(self) -> FlavorsResourceWithStreamingResponse: @cached_property def clusters(self) -> ClustersResourceWithStreamingResponse: + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ return ClustersResourceWithStreamingResponse(self._k8s.clusters) @@ -238,4 +253,7 @@ def flavors(self) -> AsyncFlavorsResourceWithStreamingResponse: @cached_property def clusters(self) -> AsyncClustersResourceWithStreamingResponse: + """ + Managed Kubernetes clusters with configurable worker node pools, networking, and cluster add-ons. + """ return AsyncClustersResourceWithStreamingResponse(self._k8s.clusters) diff --git a/src/gcore/resources/cloud/load_balancers/listeners.py b/src/gcore/resources/cloud/load_balancers/listeners.py index c9905c4f..b3cc6b7e 100644 --- a/src/gcore/resources/cloud/load_balancers/listeners.py +++ b/src/gcore/resources/cloud/load_balancers/listeners.py @@ -35,6 +35,10 @@ class ListenersResource(SyncAPIResource): + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ + @cached_property def with_raw_response(self) -> ListenersResourceWithRawResponse: """ @@ -589,6 +593,10 @@ def update_and_poll( class AsyncListenersResource(AsyncAPIResource): + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ + @cached_property def with_raw_response(self) -> AsyncListenersResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/load_balancers/load_balancers.py b/src/gcore/resources/cloud/load_balancers/load_balancers.py index 54c7ef99..e3ec8a2a 100644 --- a/src/gcore/resources/cloud/load_balancers/load_balancers.py +++ b/src/gcore/resources/cloud/load_balancers/load_balancers.py @@ -88,6 +88,10 @@ class LoadBalancersResource(SyncAPIResource): + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ + @cached_property def l7_policies(self) -> L7PoliciesResource: return L7PoliciesResource(self._client) @@ -98,10 +102,16 @@ def flavors(self) -> FlavorsResource: @cached_property def listeners(self) -> ListenersResource: + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ return ListenersResource(self._client) @cached_property def pools(self) -> PoolsResource: + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ return PoolsResource(self._client) @cached_property @@ -840,6 +850,10 @@ def resize( class AsyncLoadBalancersResource(AsyncAPIResource): + """ + Load balancers distribute incoming traffic across multiple instances with support for listeners, pools, and health monitoring. + """ + @cached_property def l7_policies(self) -> AsyncL7PoliciesResource: return AsyncL7PoliciesResource(self._client) @@ -850,10 +864,16 @@ def flavors(self) -> AsyncFlavorsResource: @cached_property def listeners(self) -> AsyncListenersResource: + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ return AsyncListenersResource(self._client) @cached_property def pools(self) -> AsyncPoolsResource: + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ return AsyncPoolsResource(self._client) @cached_property @@ -1643,10 +1663,16 @@ def flavors(self) -> FlavorsResourceWithRawResponse: @cached_property def listeners(self) -> ListenersResourceWithRawResponse: + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ return ListenersResourceWithRawResponse(self._load_balancers.listeners) @cached_property def pools(self) -> PoolsResourceWithRawResponse: + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ return PoolsResourceWithRawResponse(self._load_balancers.pools) @cached_property @@ -1708,10 +1734,16 @@ def flavors(self) -> AsyncFlavorsResourceWithRawResponse: @cached_property def listeners(self) -> AsyncListenersResourceWithRawResponse: + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ return AsyncListenersResourceWithRawResponse(self._load_balancers.listeners) @cached_property def pools(self) -> AsyncPoolsResourceWithRawResponse: + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ return AsyncPoolsResourceWithRawResponse(self._load_balancers.pools) @cached_property @@ -1773,10 +1805,16 @@ def flavors(self) -> FlavorsResourceWithStreamingResponse: @cached_property def listeners(self) -> ListenersResourceWithStreamingResponse: + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ return ListenersResourceWithStreamingResponse(self._load_balancers.listeners) @cached_property def pools(self) -> PoolsResourceWithStreamingResponse: + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ return PoolsResourceWithStreamingResponse(self._load_balancers.pools) @cached_property @@ -1838,10 +1876,16 @@ def flavors(self) -> AsyncFlavorsResourceWithStreamingResponse: @cached_property def listeners(self) -> AsyncListenersResourceWithStreamingResponse: + """ + Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools. + """ return AsyncListenersResourceWithStreamingResponse(self._load_balancers.listeners) @cached_property def pools(self) -> AsyncPoolsResourceWithStreamingResponse: + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ return AsyncPoolsResourceWithStreamingResponse(self._load_balancers.pools) @cached_property diff --git a/src/gcore/resources/cloud/load_balancers/pools/members.py b/src/gcore/resources/cloud/load_balancers/pools/members.py index d28d22ef..09839b3e 100644 --- a/src/gcore/resources/cloud/load_balancers/pools/members.py +++ b/src/gcore/resources/cloud/load_balancers/pools/members.py @@ -24,6 +24,10 @@ class MembersResource(SyncAPIResource): + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ + @cached_property def with_raw_response(self) -> MembersResourceWithRawResponse: """ @@ -204,6 +208,10 @@ def delete( class AsyncMembersResource(AsyncAPIResource): + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ + @cached_property def with_raw_response(self) -> AsyncMembersResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/load_balancers/pools/pools.py b/src/gcore/resources/cloud/load_balancers/pools/pools.py index 67c9cb79..8dc3f903 100644 --- a/src/gcore/resources/cloud/load_balancers/pools/pools.py +++ b/src/gcore/resources/cloud/load_balancers/pools/pools.py @@ -45,12 +45,19 @@ class PoolsResource(SyncAPIResource): + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ + @cached_property def health_monitors(self) -> HealthMonitorsResource: return HealthMonitorsResource(self._client) @cached_property def members(self) -> MembersResource: + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ return MembersResource(self._client) @cached_property @@ -620,12 +627,19 @@ def update_and_poll( class AsyncPoolsResource(AsyncAPIResource): + """ + Load balancer pools group backend instances with a load balancing algorithm and health monitoring configuration. + """ + @cached_property def health_monitors(self) -> AsyncHealthMonitorsResource: return AsyncHealthMonitorsResource(self._client) @cached_property def members(self) -> AsyncMembersResource: + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ return AsyncMembersResource(self._client) @cached_property @@ -1229,6 +1243,9 @@ def health_monitors(self) -> HealthMonitorsResourceWithRawResponse: @cached_property def members(self) -> MembersResourceWithRawResponse: + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ return MembersResourceWithRawResponse(self._pools.members) @@ -1267,6 +1284,9 @@ def health_monitors(self) -> AsyncHealthMonitorsResourceWithRawResponse: @cached_property def members(self) -> AsyncMembersResourceWithRawResponse: + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ return AsyncMembersResourceWithRawResponse(self._pools.members) @@ -1305,6 +1325,9 @@ def health_monitors(self) -> HealthMonitorsResourceWithStreamingResponse: @cached_property def members(self) -> MembersResourceWithStreamingResponse: + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ return MembersResourceWithStreamingResponse(self._pools.members) @@ -1343,4 +1366,7 @@ def health_monitors(self) -> AsyncHealthMonitorsResourceWithStreamingResponse: @cached_property def members(self) -> AsyncMembersResourceWithStreamingResponse: + """ + Pool members represent backend instances that receive load-balanced traffic from a pool. + """ return AsyncMembersResourceWithStreamingResponse(self._pools.members) diff --git a/src/gcore/resources/cloud/networks/networks.py b/src/gcore/resources/cloud/networks/networks.py index 0ca1e355..88349304 100644 --- a/src/gcore/resources/cloud/networks/networks.py +++ b/src/gcore/resources/cloud/networks/networks.py @@ -44,12 +44,22 @@ class NetworksResource(SyncAPIResource): + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ + @cached_property def subnets(self) -> SubnetsResource: + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ return SubnetsResource(self._client) @cached_property def routers(self) -> RoutersResource: + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ return RoutersResource(self._client) @cached_property @@ -491,12 +501,22 @@ def get( class AsyncNetworksResource(AsyncAPIResource): + """ + Networks provide software-defined networking infrastructure for connecting instances and other cloud resources within a region. + """ + @cached_property def subnets(self) -> AsyncSubnetsResource: + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ return AsyncSubnetsResource(self._client) @cached_property def routers(self) -> AsyncRoutersResource: + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ return AsyncRoutersResource(self._client) @cached_property @@ -965,10 +985,16 @@ def __init__(self, networks: NetworksResource) -> None: @cached_property def subnets(self) -> SubnetsResourceWithRawResponse: + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ return SubnetsResourceWithRawResponse(self._networks.subnets) @cached_property def routers(self) -> RoutersResourceWithRawResponse: + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ return RoutersResourceWithRawResponse(self._networks.routers) @@ -1000,10 +1026,16 @@ def __init__(self, networks: AsyncNetworksResource) -> None: @cached_property def subnets(self) -> AsyncSubnetsResourceWithRawResponse: + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ return AsyncSubnetsResourceWithRawResponse(self._networks.subnets) @cached_property def routers(self) -> AsyncRoutersResourceWithRawResponse: + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ return AsyncRoutersResourceWithRawResponse(self._networks.routers) @@ -1035,10 +1067,16 @@ def __init__(self, networks: NetworksResource) -> None: @cached_property def subnets(self) -> SubnetsResourceWithStreamingResponse: + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ return SubnetsResourceWithStreamingResponse(self._networks.subnets) @cached_property def routers(self) -> RoutersResourceWithStreamingResponse: + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ return RoutersResourceWithStreamingResponse(self._networks.routers) @@ -1070,8 +1108,14 @@ def __init__(self, networks: AsyncNetworksResource) -> None: @cached_property def subnets(self) -> AsyncSubnetsResourceWithStreamingResponse: + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ return AsyncSubnetsResourceWithStreamingResponse(self._networks.subnets) @cached_property def routers(self) -> AsyncRoutersResourceWithStreamingResponse: + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ return AsyncRoutersResourceWithStreamingResponse(self._networks.routers) diff --git a/src/gcore/resources/cloud/networks/routers.py b/src/gcore/resources/cloud/networks/routers.py index 23ed228f..1d32e324 100644 --- a/src/gcore/resources/cloud/networks/routers.py +++ b/src/gcore/resources/cloud/networks/routers.py @@ -33,6 +33,10 @@ class RoutersResource(SyncAPIResource): + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ + @cached_property def with_raw_response(self) -> RoutersResourceWithRawResponse: """ @@ -403,6 +407,10 @@ def get( class AsyncRoutersResource(AsyncAPIResource): + """ + Routers interconnect subnets and manage network routing, including external gateway connectivity and static routes. + """ + @cached_property def with_raw_response(self) -> AsyncRoutersResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/networks/subnets.py b/src/gcore/resources/cloud/networks/subnets.py index e79e88ff..ddf5baaf 100644 --- a/src/gcore/resources/cloud/networks/subnets.py +++ b/src/gcore/resources/cloud/networks/subnets.py @@ -30,6 +30,10 @@ class SubnetsResource(SyncAPIResource): + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ + @cached_property def with_raw_response(self) -> SubnetsResourceWithRawResponse: """ @@ -499,6 +503,10 @@ def get( class AsyncSubnetsResource(AsyncAPIResource): + """ + Subnets define IP address ranges within a network for instance connectivity, with support for DHCP and DNS configuration. + """ + @cached_property def with_raw_response(self) -> AsyncSubnetsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/placement_groups.py b/src/gcore/resources/cloud/placement_groups.py index 243dd294..d51fd37d 100644 --- a/src/gcore/resources/cloud/placement_groups.py +++ b/src/gcore/resources/cloud/placement_groups.py @@ -27,7 +27,7 @@ class PlacementGroupsResource(SyncAPIResource): """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ @cached_property @@ -215,7 +215,7 @@ def get( class AsyncPlacementGroupsResource(AsyncAPIResource): """ - Placement Groups allow you to specific a policy that determines whether Virtual Machines will be hosted on the same physical server or on different ones. + Placement groups enforce affinity or anti-affinity policies that control whether virtual machines are hosted on the same or different physical servers. """ @cached_property diff --git a/src/gcore/resources/cloud/projects.py b/src/gcore/resources/cloud/projects.py index f8c47c0c..5e17bd1d 100644 --- a/src/gcore/resources/cloud/projects.py +++ b/src/gcore/resources/cloud/projects.py @@ -27,6 +27,10 @@ class ProjectsResource(SyncAPIResource): + """ + Projects are organizational units that group cloud resources for access control and billing. + """ + @cached_property def with_raw_response(self) -> ProjectsResourceWithRawResponse: """ @@ -281,6 +285,10 @@ def get( class AsyncProjectsResource(AsyncAPIResource): + """ + Projects are organizational units that group cloud resources for access control and billing. + """ + @cached_property def with_raw_response(self) -> AsyncProjectsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/regions.py b/src/gcore/resources/cloud/regions.py index c25f69f5..addf6699 100644 --- a/src/gcore/resources/cloud/regions.py +++ b/src/gcore/resources/cloud/regions.py @@ -25,6 +25,10 @@ class RegionsResource(SyncAPIResource): + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ + @cached_property def with_raw_response(self) -> RegionsResourceWithRawResponse: """ @@ -155,6 +159,10 @@ def get( class AsyncRegionsResource(AsyncAPIResource): + """ + Regions represent available Gcore cloud data centers with information about supported services and volume types. + """ + @cached_property def with_raw_response(self) -> AsyncRegionsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py b/src/gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py index 35da4dca..4bcd8c5a 100644 --- a/src/gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py +++ b/src/gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py @@ -41,6 +41,10 @@ class ReservedFixedIPsResource(SyncAPIResource): + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ + @cached_property def vip(self) -> VipResource: return VipResource(self._client) @@ -806,6 +810,10 @@ def delete_and_poll( class AsyncReservedFixedIPsResource(AsyncAPIResource): + """ + Reserved fixed IPs are static IP addresses that persist independently of instances and can be used as virtual IPs (VIPs) for high availability. + """ + @cached_property def vip(self) -> AsyncVipResource: return AsyncVipResource(self._client) diff --git a/src/gcore/resources/cloud/secrets.py b/src/gcore/resources/cloud/secrets.py index 0e506c6d..9895c974 100644 --- a/src/gcore/resources/cloud/secrets.py +++ b/src/gcore/resources/cloud/secrets.py @@ -27,6 +27,10 @@ class SecretsResource(SyncAPIResource): + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ + @cached_property def with_raw_response(self) -> SecretsResourceWithRawResponse: """ @@ -296,6 +300,10 @@ def upload_tls_certificate_and_poll( class AsyncSecretsResource(AsyncAPIResource): + """ + Secrets store sensitive data such as TLS certificates and private keys in encrypted form within a cloud region. + """ + @cached_property def with_raw_response(self) -> AsyncSecretsResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/security_groups/rules.py b/src/gcore/resources/cloud/security_groups/rules.py index ce3c1b23..925ffac4 100644 --- a/src/gcore/resources/cloud/security_groups/rules.py +++ b/src/gcore/resources/cloud/security_groups/rules.py @@ -27,6 +27,10 @@ class RulesResource(SyncAPIResource): + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ + @cached_property def with_raw_response(self) -> RulesResourceWithRawResponse: """ @@ -468,6 +472,10 @@ def delete_and_poll( class AsyncRulesResource(AsyncAPIResource): + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ + @cached_property def with_raw_response(self) -> AsyncRulesResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/security_groups/security_groups.py b/src/gcore/resources/cloud/security_groups/security_groups.py index 52b209e1..51519595 100644 --- a/src/gcore/resources/cloud/security_groups/security_groups.py +++ b/src/gcore/resources/cloud/security_groups/security_groups.py @@ -40,8 +40,15 @@ class SecurityGroupsResource(SyncAPIResource): + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ + @cached_property def rules(self) -> RulesResource: + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ return RulesResource(self._client) @cached_property @@ -598,8 +605,15 @@ def update_and_poll( class AsyncSecurityGroupsResource(AsyncAPIResource): + """ + Security groups act as virtual firewalls controlling inbound and outbound traffic for instances and other resources. + """ + @cached_property def rules(self) -> AsyncRulesResource: + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ return AsyncRulesResource(self._client) @cached_property @@ -1189,6 +1203,9 @@ def __init__(self, security_groups: SecurityGroupsResource) -> None: @cached_property def rules(self) -> RulesResourceWithRawResponse: + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ return RulesResourceWithRawResponse(self._security_groups.rules) @@ -1226,6 +1243,9 @@ def __init__(self, security_groups: AsyncSecurityGroupsResource) -> None: @cached_property def rules(self) -> AsyncRulesResourceWithRawResponse: + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ return AsyncRulesResourceWithRawResponse(self._security_groups.rules) @@ -1263,6 +1283,9 @@ def __init__(self, security_groups: SecurityGroupsResource) -> None: @cached_property def rules(self) -> RulesResourceWithStreamingResponse: + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ return RulesResourceWithStreamingResponse(self._security_groups.rules) @@ -1300,4 +1323,7 @@ def __init__(self, security_groups: AsyncSecurityGroupsResource) -> None: @cached_property def rules(self) -> AsyncRulesResourceWithStreamingResponse: + """ + Security group rules define individual traffic permissions specifying protocol, port range, direction, and allowed sources. + """ return AsyncRulesResourceWithStreamingResponse(self._security_groups.rules) diff --git a/src/gcore/resources/cloud/ssh_keys.py b/src/gcore/resources/cloud/ssh_keys.py index cd2c058d..59219d70 100644 --- a/src/gcore/resources/cloud/ssh_keys.py +++ b/src/gcore/resources/cloud/ssh_keys.py @@ -26,6 +26,10 @@ class SSHKeysResource(SyncAPIResource): + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ + @cached_property def with_raw_response(self) -> SSHKeysResourceWithRawResponse: """ @@ -293,6 +297,10 @@ def get( class AsyncSSHKeysResource(AsyncAPIResource): + """ + SSH key pairs provide secure authentication to cloud instances, supporting both generated and imported public keys. + """ + @cached_property def with_raw_response(self) -> AsyncSSHKeysResourceWithRawResponse: """ diff --git a/src/gcore/resources/cloud/volumes.py b/src/gcore/resources/cloud/volumes.py index f07ab83d..e45ca1b0 100644 --- a/src/gcore/resources/cloud/volumes.py +++ b/src/gcore/resources/cloud/volumes.py @@ -37,6 +37,10 @@ class VolumesResource(SyncAPIResource): + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ + @cached_property def with_raw_response(self) -> VolumesResourceWithRawResponse: """ @@ -1281,6 +1285,10 @@ def resize_and_poll( class AsyncVolumesResource(AsyncAPIResource): + """ + Volumes are block storage devices that can be attached to instances as boot or data disks, with support for resizing and type changes. + """ + @cached_property def with_raw_response(self) -> AsyncVolumesResourceWithRawResponse: """ diff --git a/src/gcore/resources/dns/dns.py b/src/gcore/resources/dns/dns.py index f942957c..c08746a4 100644 --- a/src/gcore/resources/dns/dns.py +++ b/src/gcore/resources/dns/dns.py @@ -79,10 +79,16 @@ def pickers(self) -> PickersResource: @cached_property def zones(self) -> ZonesResource: + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ return ZonesResource(self._client) @cached_property def network_mappings(self) -> NetworkMappingsResource: + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ return NetworkMappingsResource(self._client) @cached_property @@ -186,10 +192,16 @@ def pickers(self) -> AsyncPickersResource: @cached_property def zones(self) -> AsyncZonesResource: + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ return AsyncZonesResource(self._client) @cached_property def network_mappings(self) -> AsyncNetworkMappingsResource: + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ return AsyncNetworkMappingsResource(self._client) @cached_property @@ -303,10 +315,16 @@ def pickers(self) -> PickersResourceWithRawResponse: @cached_property def zones(self) -> ZonesResourceWithRawResponse: + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ return ZonesResourceWithRawResponse(self._dns.zones) @cached_property def network_mappings(self) -> NetworkMappingsResourceWithRawResponse: + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ return NetworkMappingsResourceWithRawResponse(self._dns.network_mappings) @@ -335,10 +353,16 @@ def pickers(self) -> AsyncPickersResourceWithRawResponse: @cached_property def zones(self) -> AsyncZonesResourceWithRawResponse: + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ return AsyncZonesResourceWithRawResponse(self._dns.zones) @cached_property def network_mappings(self) -> AsyncNetworkMappingsResourceWithRawResponse: + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ return AsyncNetworkMappingsResourceWithRawResponse(self._dns.network_mappings) @@ -367,10 +391,16 @@ def pickers(self) -> PickersResourceWithStreamingResponse: @cached_property def zones(self) -> ZonesResourceWithStreamingResponse: + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ return ZonesResourceWithStreamingResponse(self._dns.zones) @cached_property def network_mappings(self) -> NetworkMappingsResourceWithStreamingResponse: + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ return NetworkMappingsResourceWithStreamingResponse(self._dns.network_mappings) @@ -399,8 +429,14 @@ def pickers(self) -> AsyncPickersResourceWithStreamingResponse: @cached_property def zones(self) -> AsyncZonesResourceWithStreamingResponse: + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ return AsyncZonesResourceWithStreamingResponse(self._dns.zones) @cached_property def network_mappings(self) -> AsyncNetworkMappingsResourceWithStreamingResponse: + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ return AsyncNetworkMappingsResourceWithStreamingResponse(self._dns.network_mappings) diff --git a/src/gcore/resources/dns/network_mappings.py b/src/gcore/resources/dns/network_mappings.py index 1feb1047..b17c7c7b 100644 --- a/src/gcore/resources/dns/network_mappings.py +++ b/src/gcore/resources/dns/network_mappings.py @@ -29,6 +29,10 @@ class NetworkMappingsResource(SyncAPIResource): + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ + @cached_property def with_raw_response(self) -> NetworkMappingsResourceWithRawResponse: """ @@ -459,6 +463,10 @@ def replace( class AsyncNetworkMappingsResource(AsyncAPIResource): + """ + DNS network mappings associate CIDR ranges with network tags for private DNS resolution and traffic-based routing. + """ + @cached_property def with_raw_response(self) -> AsyncNetworkMappingsResourceWithRawResponse: """ diff --git a/src/gcore/resources/dns/zones/rrsets.py b/src/gcore/resources/dns/zones/rrsets.py index 736b590d..9871c267 100644 --- a/src/gcore/resources/dns/zones/rrsets.py +++ b/src/gcore/resources/dns/zones/rrsets.py @@ -32,6 +32,10 @@ class RrsetsResource(SyncAPIResource): + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ + @cached_property def with_raw_response(self) -> RrsetsResourceWithRawResponse: """ @@ -463,6 +467,10 @@ def replace( class AsyncRrsetsResource(AsyncAPIResource): + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ + @cached_property def with_raw_response(self) -> AsyncRrsetsResourceWithRawResponse: """ diff --git a/src/gcore/resources/dns/zones/zones.py b/src/gcore/resources/dns/zones/zones.py index 94bf34c2..65872318 100644 --- a/src/gcore/resources/dns/zones/zones.py +++ b/src/gcore/resources/dns/zones/zones.py @@ -54,12 +54,19 @@ class ZonesResource(SyncAPIResource): + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ + @cached_property def dnssec(self) -> DnssecResource: return DnssecResource(self._client) @cached_property def rrsets(self) -> RrsetsResource: + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ return RrsetsResource(self._client) @cached_property @@ -691,12 +698,19 @@ def replace( class AsyncZonesResource(AsyncAPIResource): + """ + DNS zones are authoritative containers for domain name records, with support for DNSSEC and SOA configuration. + """ + @cached_property def dnssec(self) -> AsyncDnssecResource: return AsyncDnssecResource(self._client) @cached_property def rrsets(self) -> AsyncRrsetsResource: + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ return AsyncRrsetsResource(self._client) @cached_property @@ -1371,6 +1385,9 @@ def dnssec(self) -> DnssecResourceWithRawResponse: @cached_property def rrsets(self) -> RrsetsResourceWithRawResponse: + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ return RrsetsResourceWithRawResponse(self._zones.rrsets) @@ -1418,6 +1435,9 @@ def dnssec(self) -> AsyncDnssecResourceWithRawResponse: @cached_property def rrsets(self) -> AsyncRrsetsResourceWithRawResponse: + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ return AsyncRrsetsResourceWithRawResponse(self._zones.rrsets) @@ -1465,6 +1485,9 @@ def dnssec(self) -> DnssecResourceWithStreamingResponse: @cached_property def rrsets(self) -> RrsetsResourceWithStreamingResponse: + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ return RrsetsResourceWithStreamingResponse(self._zones.rrsets) @@ -1512,4 +1535,7 @@ def dnssec(self) -> AsyncDnssecResourceWithStreamingResponse: @cached_property def rrsets(self) -> AsyncRrsetsResourceWithStreamingResponse: + """ + DNS resource record sets (RRsets) define individual DNS records such as A, AAAA, CNAME, MX, and TXT with TTL and geo-balancing settings. + """ return AsyncRrsetsResourceWithStreamingResponse(self._zones.rrsets) diff --git a/src/gcore/resources/fastedge/apps/apps.py b/src/gcore/resources/fastedge/apps/apps.py index 4d38f97a..a4da2906 100644 --- a/src/gcore/resources/fastedge/apps/apps.py +++ b/src/gcore/resources/fastedge/apps/apps.py @@ -36,7 +36,7 @@ class AppsResource(SyncAPIResource): """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ @cached_property @@ -436,7 +436,7 @@ def replace( class AsyncAppsResource(AsyncAPIResource): """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ @cached_property diff --git a/src/gcore/resources/fastedge/binaries.py b/src/gcore/resources/fastedge/binaries.py index a49da25e..62c107af 100644 --- a/src/gcore/resources/fastedge/binaries.py +++ b/src/gcore/resources/fastedge/binaries.py @@ -36,7 +36,7 @@ class BinariesResource(SyncAPIResource): """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ @cached_property @@ -176,7 +176,7 @@ def get( class AsyncBinariesResource(AsyncAPIResource): """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ @cached_property diff --git a/src/gcore/resources/fastedge/fastedge.py b/src/gcore/resources/fastedge/fastedge.py index 82c381fe..539366a3 100644 --- a/src/gcore/resources/fastedge/fastedge.py +++ b/src/gcore/resources/fastedge/fastedge.py @@ -77,13 +77,15 @@ def templates(self) -> TemplatesResource: @cached_property def secrets(self) -> SecretsResource: - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ return SecretsResource(self._client) @cached_property def binaries(self) -> BinariesResource: """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ return BinariesResource(self._client) @@ -95,7 +97,7 @@ def statistics(self) -> StatisticsResource: @cached_property def apps(self) -> AppsResource: """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ return AppsResource(self._client) @@ -153,13 +155,15 @@ def templates(self) -> AsyncTemplatesResource: @cached_property def secrets(self) -> AsyncSecretsResource: - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ return AsyncSecretsResource(self._client) @cached_property def binaries(self) -> AsyncBinariesResource: """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ return AsyncBinariesResource(self._client) @@ -171,7 +175,7 @@ def statistics(self) -> AsyncStatisticsResource: @cached_property def apps(self) -> AsyncAppsResource: """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ return AsyncAppsResource(self._client) @@ -234,13 +238,15 @@ def templates(self) -> TemplatesResourceWithRawResponse: @cached_property def secrets(self) -> SecretsResourceWithRawResponse: - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ return SecretsResourceWithRawResponse(self._fastedge.secrets) @cached_property def binaries(self) -> BinariesResourceWithRawResponse: """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ return BinariesResourceWithRawResponse(self._fastedge.binaries) @@ -252,7 +258,7 @@ def statistics(self) -> StatisticsResourceWithRawResponse: @cached_property def apps(self) -> AppsResourceWithRawResponse: """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ return AppsResourceWithRawResponse(self._fastedge.apps) @@ -277,13 +283,15 @@ def templates(self) -> AsyncTemplatesResourceWithRawResponse: @cached_property def secrets(self) -> AsyncSecretsResourceWithRawResponse: - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ return AsyncSecretsResourceWithRawResponse(self._fastedge.secrets) @cached_property def binaries(self) -> AsyncBinariesResourceWithRawResponse: """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ return AsyncBinariesResourceWithRawResponse(self._fastedge.binaries) @@ -295,7 +303,7 @@ def statistics(self) -> AsyncStatisticsResourceWithRawResponse: @cached_property def apps(self) -> AsyncAppsResourceWithRawResponse: """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ return AsyncAppsResourceWithRawResponse(self._fastedge.apps) @@ -320,13 +328,15 @@ def templates(self) -> TemplatesResourceWithStreamingResponse: @cached_property def secrets(self) -> SecretsResourceWithStreamingResponse: - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ return SecretsResourceWithStreamingResponse(self._fastedge.secrets) @cached_property def binaries(self) -> BinariesResourceWithStreamingResponse: """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ return BinariesResourceWithStreamingResponse(self._fastedge.binaries) @@ -338,7 +348,7 @@ def statistics(self) -> StatisticsResourceWithStreamingResponse: @cached_property def apps(self) -> AppsResourceWithStreamingResponse: """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ return AppsResourceWithStreamingResponse(self._fastedge.apps) @@ -363,13 +373,15 @@ def templates(self) -> AsyncTemplatesResourceWithStreamingResponse: @cached_property def secrets(self) -> AsyncSecretsResourceWithStreamingResponse: - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ return AsyncSecretsResourceWithStreamingResponse(self._fastedge.secrets) @cached_property def binaries(self) -> AsyncBinariesResourceWithStreamingResponse: """ - Binaries are WebAssembly executables that are actually executed when app is ran. + FastEdge binaries are immutable WebAssembly modules that implement edge application logic. """ return AsyncBinariesResourceWithStreamingResponse(self._fastedge.binaries) @@ -381,7 +393,7 @@ def statistics(self) -> AsyncStatisticsResourceWithStreamingResponse: @cached_property def apps(self) -> AsyncAppsResourceWithStreamingResponse: """ - Apps are descriptions of edge apps, that reference the binary and may contain app-specific settings, such as environment variables. + FastEdge applications combine a WebAssembly binary with configuration, environment variables, and secrets for deployment at the CDN edge. """ return AsyncAppsResourceWithStreamingResponse(self._fastedge.apps) diff --git a/src/gcore/resources/fastedge/secrets.py b/src/gcore/resources/fastedge/secrets.py index d435256f..5c37ade0 100644 --- a/src/gcore/resources/fastedge/secrets.py +++ b/src/gcore/resources/fastedge/secrets.py @@ -32,7 +32,9 @@ class SecretsResource(SyncAPIResource): - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ @cached_property def with_raw_response(self) -> SecretsResourceWithRawResponse: @@ -314,7 +316,9 @@ def replace( class AsyncSecretsResource(AsyncAPIResource): - """Secret values that can be used in apps""" + """ + FastEdge secrets store sensitive values such as API keys and tokens that can be referenced by FastEdge applications. + """ @cached_property def with_raw_response(self) -> AsyncSecretsResourceWithRawResponse: diff --git a/src/gcore/resources/waap/domains/domains.py b/src/gcore/resources/waap/domains/domains.py index c366f47e..e214ec63 100644 --- a/src/gcore/resources/waap/domains/domains.py +++ b/src/gcore/resources/waap/domains/domains.py @@ -116,6 +116,10 @@ class DomainsResource(SyncAPIResource): + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ + @cached_property def policies(self) -> PoliciesResource: return PoliciesResource(self._client) @@ -384,6 +388,10 @@ def list_rule_sets( class AsyncDomainsResource(AsyncAPIResource): + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ + @cached_property def policies(self) -> AsyncPoliciesResource: return AsyncPoliciesResource(self._client) diff --git a/src/gcore/resources/waap/waap.py b/src/gcore/resources/waap/waap.py index d5509b5f..1603bb09 100644 --- a/src/gcore/resources/waap/waap.py +++ b/src/gcore/resources/waap/waap.py @@ -90,6 +90,9 @@ def statistics(self) -> StatisticsResource: @cached_property def domains(self) -> DomainsResource: + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ return DomainsResource(self._client) @cached_property @@ -162,6 +165,9 @@ def statistics(self) -> AsyncStatisticsResource: @cached_property def domains(self) -> AsyncDomainsResource: + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ return AsyncDomainsResource(self._client) @cached_property @@ -241,6 +247,9 @@ def statistics(self) -> StatisticsResourceWithRawResponse: @cached_property def domains(self) -> DomainsResourceWithRawResponse: + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ return DomainsResourceWithRawResponse(self._waap.domains) @cached_property @@ -282,6 +291,9 @@ def statistics(self) -> AsyncStatisticsResourceWithRawResponse: @cached_property def domains(self) -> AsyncDomainsResourceWithRawResponse: + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ return AsyncDomainsResourceWithRawResponse(self._waap.domains) @cached_property @@ -323,6 +335,9 @@ def statistics(self) -> StatisticsResourceWithStreamingResponse: @cached_property def domains(self) -> DomainsResourceWithStreamingResponse: + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ return DomainsResourceWithStreamingResponse(self._waap.domains) @cached_property @@ -364,6 +379,9 @@ def statistics(self) -> AsyncStatisticsResourceWithStreamingResponse: @cached_property def domains(self) -> AsyncDomainsResourceWithStreamingResponse: + """ + WAAP domains enable Web Application and API Protection for monitoring and defending web applications against security threats. + """ return AsyncDomainsResourceWithStreamingResponse(self._waap.domains) @cached_property diff --git a/src/gcore/types/cloud/gpu_baremetal/gpu_baremetal_cluster.py b/src/gcore/types/cloud/gpu_baremetal/gpu_baremetal_cluster.py index 5eb7f5da..cba48130 100644 --- a/src/gcore/types/cloud/gpu_baremetal/gpu_baremetal_cluster.py +++ b/src/gcore/types/cloud/gpu_baremetal/gpu_baremetal_cluster.py @@ -149,7 +149,7 @@ class GPUBaremetalCluster(BaseModel): servers_settings: ServersSettings status: Literal[ - "active", "creating", "degraded", "deleting", "error", "new", "rebooting", "rebuilding", "resizing", "shutoff" + "active", "creating", "degraded", "deleting", "error", "rebooting", "rebuilding", "resizing", "shutoff" ] """Cluster status""" diff --git a/src/gcore/types/cloud/gpu_virtual/gpu_virtual_cluster.py b/src/gcore/types/cloud/gpu_virtual/gpu_virtual_cluster.py index 3561daea..d31d1b36 100644 --- a/src/gcore/types/cloud/gpu_virtual/gpu_virtual_cluster.py +++ b/src/gcore/types/cloud/gpu_virtual/gpu_virtual_cluster.py @@ -177,7 +177,7 @@ class GPUVirtualCluster(BaseModel): servers_settings: ServersSettings status: Literal[ - "active", "creating", "degraded", "deleting", "error", "new", "rebooting", "rebuilding", "resizing", "shutoff" + "active", "creating", "degraded", "deleting", "error", "rebooting", "rebuilding", "resizing", "shutoff" ] """Cluster status""" diff --git a/src/gcore/types/dns/zones/dnssec_update_response.py b/src/gcore/types/dns/zones/dnssec_update_response.py index e552fd18..b60b537d 100644 --- a/src/gcore/types/dns/zones/dnssec_update_response.py +++ b/src/gcore/types/dns/zones/dnssec_update_response.py @@ -36,3 +36,5 @@ class DnssecUpdateResponse(BaseModel): public_key: Optional[str] = None """Represents the public key used in the DS record.""" + + uuid: Optional[str] = None