gcore 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

gcore/resources/cloud/load_balancers/load_balancers.py

@@ -172,8 +172,9 @@ class LoadBalancersResource(SyncAPIResource):
 
           preferred_connectivity: Preferred option to establish connectivity between load balancer and its pools
               members. L2 provides best performance, L3 provides less IPs usage. It is taking
-              effect only if instance_id + ip_address is provided, not subnet_id + ip_address,
-              because we're considering this as intentional subnet_id specification.
+              effect only if `instance_id` + `ip_address` is provided, not `subnet_id` +
+              `ip_address`, because we're considering this as intentional `subnet_id`
+              specification.
 
           tags: Key-value tags to associate with the resource. A tag is a key-value pair that
               can be associated with a resource, enabling efficient filtering and grouping for
@@ -181,16 +182,17 @@ class LoadBalancersResource(SyncAPIResource):
               modified by the user. Tags are also integrated with cost reports, allowing cost
               data to be filtered based on tag keys or values.
 
-          vip_ip_family: IP family for load balancer subnet auto-selection if vip_network_id is specified
+          vip_ip_family: IP family for load balancer subnet auto-selection if `vip_network_id` is
+              specified
 
           vip_network_id: Network ID for load balancer. If not specified, default external network will be
-              used. Mutually exclusive with vip_port_id
+              used. Mutually exclusive with `vip_port_id`
 
           vip_port_id: Existing Reserved Fixed IP port ID for load balancer. Mutually exclusive with
-              vip_network_id
+              `vip_network_id`
 
-          vip_subnet_id: Subnet ID for load balancer. If not specified, any subnet from vip_network_id
-              will be selected. Ignored when vip_network_id is not specified.
+          vip_subnet_id: Subnet ID for load balancer. If not specified, any subnet from `vip_network_id`
+              will be selected. Ignored when `vip_network_id` is not specified.
 
           extra_headers: Send extra headers
 
@@ -323,17 +325,17 @@ class LoadBalancersResource(SyncAPIResource):
 
           offset: Offset value is used to exclude the first set of records from the result.
 
-          order_by: Ordering Load Balancer list result by name, created_at, updated_at,
-              operating_status, provisioning_status, vip_address, vip_ip_family and flavor
-              fields of the load balancer and directions (name.asc), default is
-              "created_at.asc"
+          order_by: Ordering Load Balancer list result by name, `created_at`, `updated_at`,
+              `operating_status`, `provisioning_status`, `vip_address`, `vip_ip_family` and
+              flavor fields of the load balancer and directions (name.asc), default is
+              "`created_at`.asc"
 
           show_stats: Show statistics
 
           tag_key: Filter by tag keys.
 
           tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
-              --data-urlencode "tag_key_value={"key": "value"}" --url
+              --data-urlencode "`tag_key_value`={"key": "value"}" --url
               "http://localhost:1111/v1/loadbalancers/1/1"
 
           with_ddos: Show Advanced DDoS protection profile, if exists
@@ -827,8 +829,9 @@ class AsyncLoadBalancersResource(AsyncAPIResource):
 
           preferred_connectivity: Preferred option to establish connectivity between load balancer and its pools
               members. L2 provides best performance, L3 provides less IPs usage. It is taking
-              effect only if instance_id + ip_address is provided, not subnet_id + ip_address,
-              because we're considering this as intentional subnet_id specification.
+              effect only if `instance_id` + `ip_address` is provided, not `subnet_id` +
+              `ip_address`, because we're considering this as intentional `subnet_id`
+              specification.
 
           tags: Key-value tags to associate with the resource. A tag is a key-value pair that
               can be associated with a resource, enabling efficient filtering and grouping for
@@ -836,16 +839,17 @@ class AsyncLoadBalancersResource(AsyncAPIResource):
               modified by the user. Tags are also integrated with cost reports, allowing cost
               data to be filtered based on tag keys or values.
 
-          vip_ip_family: IP family for load balancer subnet auto-selection if vip_network_id is specified
+          vip_ip_family: IP family for load balancer subnet auto-selection if `vip_network_id` is
+              specified
 
           vip_network_id: Network ID for load balancer. If not specified, default external network will be
-              used. Mutually exclusive with vip_port_id
+              used. Mutually exclusive with `vip_port_id`
 
           vip_port_id: Existing Reserved Fixed IP port ID for load balancer. Mutually exclusive with
-              vip_network_id
+              `vip_network_id`
 
-          vip_subnet_id: Subnet ID for load balancer. If not specified, any subnet from vip_network_id
-              will be selected. Ignored when vip_network_id is not specified.
+          vip_subnet_id: Subnet ID for load balancer. If not specified, any subnet from `vip_network_id`
+              will be selected. Ignored when `vip_network_id` is not specified.
 
           extra_headers: Send extra headers
 
@@ -978,17 +982,17 @@ class AsyncLoadBalancersResource(AsyncAPIResource):
 
           offset: Offset value is used to exclude the first set of records from the result.
 
-          order_by: Ordering Load Balancer list result by name, created_at, updated_at,
-              operating_status, provisioning_status, vip_address, vip_ip_family and flavor
-              fields of the load balancer and directions (name.asc), default is
-              "created_at.asc"
+          order_by: Ordering Load Balancer list result by name, `created_at`, `updated_at`,
+              `operating_status`, `provisioning_status`, `vip_address`, `vip_ip_family` and
+              flavor fields of the load balancer and directions (name.asc), default is
+              "`created_at`.asc"
 
           show_stats: Show statistics
 
           tag_key: Filter by tag keys.
 
           tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
-              --data-urlencode "tag_key_value={"key": "value"}" --url
+              --data-urlencode "`tag_key_value`={"key": "value"}" --url
               "http://localhost:1111/v1/loadbalancers/1/1"
 
           with_ddos: Show Advanced DDoS protection profile, if exists

gcore/resources/cloud/load_balancers/pools/members.py

@@ -80,15 +80,15 @@ class MembersResource(SyncAPIResource):
 
           admin_state_up: true if enabled. Defaults to true
 
-          instance_id: Either subnet_id or instance_id should be provided
+          instance_id: Either `subnet_id` or `instance_id` should be provided
 
           monitor_address: An alternate IP address used for health monitoring of a backend member. Default
               is null which monitors the member address.
 
           monitor_port: An alternate protocol port used for health monitoring of a backend member.
-              Default is null which monitors the member protocol_port.
+              Default is null which monitors the member `protocol_port`.
 
-          subnet_id: Either subnet_id or instance_id should be provided
+          subnet_id: Either `subnet_id` or `instance_id` should be provided
 
           weight: Member weight. Valid values: 0 to 256, defaults to 1
 
@@ -235,15 +235,15 @@ class AsyncMembersResource(AsyncAPIResource):
 
           admin_state_up: true if enabled. Defaults to true
 
-          instance_id: Either subnet_id or instance_id should be provided
+          instance_id: Either `subnet_id` or `instance_id` should be provided
 
           monitor_address: An alternate IP address used for health monitoring of a backend member. Default
               is null which monitors the member address.
 
           monitor_port: An alternate protocol port used for health monitoring of a backend member.
-              Default is null which monitors the member protocol_port.
+              Default is null which monitors the member `protocol_port`.
 
-          subnet_id: Either subnet_id or instance_id should be provided
+          subnet_id: Either `subnet_id` or `instance_id` should be provided
 
           weight: Member weight. Valid values: 0 to 256, defaults to 1
 

gcore/resources/cloud/networks/networks.py

@@ -218,10 +218,10 @@ class NetworksResource(SyncAPIResource):
           order_by: Ordering networks list result by `name`, `created_at` fields of the network and
               directions (`created_at.desc`).
 
-          tag_key: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2
+          tag_key: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2
 
           tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
-              "tag_key_value={"key": "value"}" --url
+              "`tag_key_value`={"key": "value"}" --url
               "https://example.com/cloud/v1/resource/1/1"
 
           extra_headers: Send extra headers
@@ -524,10 +524,10 @@ class AsyncNetworksResource(AsyncAPIResource):
           order_by: Ordering networks list result by `name`, `created_at` fields of the network and
               directions (`created_at.desc`).
 
-          tag_key: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2
+          tag_key: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2
 
           tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
-              "tag_key_value={"key": "value"}" --url
+              "`tag_key_value`={"key": "value"}" --url
               "https://example.com/cloud/v1/resource/1/1"
 
           extra_headers: Send extra headers

gcore/resources/cloud/networks/subnets.py

@@ -87,7 +87,7 @@ class SubnetsResource(SyncAPIResource):
           network_id: Network ID
 
           connect_to_network_router: True if the network's router should get a gateway in this subnet. Must be
-              explicitly 'false' when gateway_ip is null.
+              explicitly 'false' when `gateway_ip` is null.
 
           dns_nameservers: List IP addresses of DNS servers to advertise via DHCP.
 
@@ -272,10 +272,10 @@ class SubnetsResource(SyncAPIResource):
               `available_ips`, `total_ips`, and `cidr` (default) fields of the subnet and
               directions (`name.asc`).
 
-          tag_key: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2
+          tag_key: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2
 
           tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
-              "tag_key_value={"key": "value"}" --url
+              "`tag_key_value`={"key": "value"}" --url
               "https://example.com/cloud/v1/resource/1/1"
 
           extra_headers: Send extra headers
@@ -463,7 +463,7 @@ class AsyncSubnetsResource(AsyncAPIResource):
           network_id: Network ID
 
           connect_to_network_router: True if the network's router should get a gateway in this subnet. Must be
-              explicitly 'false' when gateway_ip is null.
+              explicitly 'false' when `gateway_ip` is null.
 
           dns_nameservers: List IP addresses of DNS servers to advertise via DHCP.
 
@@ -648,10 +648,10 @@ class AsyncSubnetsResource(AsyncAPIResource):
               `available_ips`, `total_ips`, and `cidr` (default) fields of the subnet and
               directions (`name.asc`).
 
-          tag_key: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2
+          tag_key: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2
 
           tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
-              "tag_key_value={"key": "value"}" --url
+              "`tag_key_value`={"key": "value"}" --url
               "https://example.com/cloud/v1/resource/1/1"
 
           extra_headers: Send extra headers

gcore/resources/cloud/registries/registries.py

@@ -104,15 +104,13 @@ class RegistriesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
-        """
-        Create a registry
+        """Create a registry
 
         Args:
           name: A name for the container registry.
 
-              Should be in lowercase, consisting only of numbers, letters and -,
-
-              with maximum length of 24 characters
+        Should be in lowercase, consisting only of
+              numbers, letters and -, with maximum length of 24 characters
 
           storage_limit: Registry storage limit, GiB
 
@@ -346,15 +344,13 @@ class AsyncRegistriesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Registry:
-        """
-        Create a registry
+        """Create a registry
 
         Args:
           name: A name for the container registry.
 
-              Should be in lowercase, consisting only of numbers, letters and -,
-
-              with maximum length of 24 characters
+        Should be in lowercase, consisting only of
+              numbers, letters and -, with maximum length of 24 characters
 
           storage_limit: Registry storage limit, GiB
 

gcore/resources/cloud/registries/users.py

@@ -68,11 +68,8 @@ class UsersResource(SyncAPIResource):
         Args:
           duration: User account operating time, days
 
-          name: A name for the registry user.
-
-              Should be in lowercase, consisting only of numbers and letters,
-
-              with maximum length of 16 characters
+          name: A name for the registry user. Should be in lowercase, consisting only of numbers
+              and letters, with maximum length of 16 characters
 
           read_only: Read-only user
 
@@ -358,11 +355,8 @@ class AsyncUsersResource(AsyncAPIResource):
         Args:
           duration: User account operating time, days
 
-          name: A name for the registry user.
-
-              Should be in lowercase, consisting only of numbers and letters,
-
-              with maximum length of 16 characters
+          name: A name for the registry user. Should be in lowercase, consisting only of numbers
+              and letters, with maximum length of 16 characters
 
           read_only: Read-only user
 

gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py

@@ -154,7 +154,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
         Args:
           network_id: Reserved fixed IP will be allocated in a subnet of this network
 
-          type: Must be 'any_subnet'.
+          type: Must be '`any_subnet`'.
 
           ip_family: Which subnets should be selected: IPv4, IPv6 or use dual stack.
 
@@ -195,7 +195,7 @@ class ReservedFixedIPsResource(SyncAPIResource):
 
           network_id: Reserved fixed IP will be allocated in a subnet of this network
 
-          type: Must be 'ip_address'.
+          type: Must be '`ip_address`'.
 
           is_vip: If reserved fixed IP is a VIP
 
@@ -333,9 +333,9 @@ class ReservedFixedIPsResource(SyncAPIResource):
 
           offset: Offset value is used to exclude the first set of records from the result
 
-          order_by: Ordering reserved fixed IP list result by name, status, updated_at, created_at
-              or fixed_ip_address fields of the reserved fixed IP and directions (status.asc),
-              default is "fixed_ip_address.asc"
+          order_by: Ordering reserved fixed IP list result by name, status, `updated_at`,
+              `created_at` or `fixed_ip_address` fields of the reserved fixed IP and
+              directions (status.asc), default is "`fixed_ip_address`.asc"
 
           vip_only: Set to true if the response should only list VIPs
 
@@ -575,7 +575,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
         Args:
           network_id: Reserved fixed IP will be allocated in a subnet of this network
 
-          type: Must be 'any_subnet'.
+          type: Must be '`any_subnet`'.
 
           ip_family: Which subnets should be selected: IPv4, IPv6 or use dual stack.
 
@@ -616,7 +616,7 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
 
           network_id: Reserved fixed IP will be allocated in a subnet of this network
 
-          type: Must be 'ip_address'.
+          type: Must be '`ip_address`'.
 
           is_vip: If reserved fixed IP is a VIP
 
@@ -754,9 +754,9 @@ class AsyncReservedFixedIPsResource(AsyncAPIResource):
 
           offset: Offset value is used to exclude the first set of records from the result
 
-          order_by: Ordering reserved fixed IP list result by name, status, updated_at, created_at
-              or fixed_ip_address fields of the reserved fixed IP and directions (status.asc),
-              default is "fixed_ip_address.asc"
+          order_by: Ordering reserved fixed IP list result by name, status, `updated_at`,
+              `created_at` or `fixed_ip_address` fields of the reserved fixed IP and
+              directions (status.asc), default is "`fixed_ip_address`.asc"
 
           vip_only: Set to true if the response should only list VIPs
 

gcore/resources/cloud/security_groups/security_groups.py

@@ -189,7 +189,7 @@ class SecurityGroupsResource(SyncAPIResource):
           tag_key: Filter by tag keys.
 
           tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
-              --data-urlencode "tag_key_value={"key": "value"}" --url
+              --data-urlencode "`tag_key_value`={"key": "value"}" --url
               "http://localhost:1111/v1/securitygroups/1/1"
 
           extra_headers: Send extra headers
@@ -540,7 +540,7 @@ class AsyncSecurityGroupsResource(AsyncAPIResource):
           tag_key: Filter by tag keys.
 
           tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
-              --data-urlencode "tag_key_value={"key": "value"}" --url
+              --data-urlencode "`tag_key_value`={"key": "value"}" --url
               "http://localhost:1111/v1/securitygroups/1/1"
 
           extra_headers: Send extra headers

gcore/resources/cloud/ssh_keys.py

@@ -60,7 +60,7 @@ class SSHKeysResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SSHKeyCreated:
         """
-        To generate a key, omit the public_key parameter from the request body
+        To generate a key, omit the `public_key` parameter from the request body
 
         Args:
           project_id: Project ID
@@ -322,7 +322,7 @@ class AsyncSSHKeysResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SSHKeyCreated:
         """
-        To generate a key, omit the public_key parameter from the request body
+        To generate a key, omit the `public_key` parameter from the request body
 
         Args:
           project_id: Project ID