|
9 | 9 | .. py:method:: create( [, custom_tags: Optional[List[compute.CustomPolicyTag]], policy_name: Optional[str], request_id: Optional[str]]) -> BudgetPolicy
|
10 | 10 |
|
11 | 11 | Create a budget policy.
|
12 |
| - |
13 |
| -Creates a new policy. |
14 |
| - |
15 |
| -:param custom_tags: List[:class:`CustomPolicyTag`] (optional) |
16 |
| - A list of tags defined by the customer. At most 40 entries are allowed per policy. |
17 |
| -:param policy_name: str (optional) |
18 |
| - The name of the policy. - Must be unique among active policies. - Can contain only characters of |
19 |
| - 0-9, a-z, A-Z, -, =, ., :, /, @, _, +, whitespace. |
20 |
| -:param request_id: str (optional) |
21 |
| - A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is |
22 |
| - recommended. This request is only idempotent if a `request_id` is provided. |
23 |
| - |
24 |
| -:returns: :class:`BudgetPolicy` |
25 |
| - |
| 12 | + |
| 13 | + Creates a new policy. |
| 14 | + |
| 15 | + :param custom_tags: List[:class:`CustomPolicyTag`] (optional) |
| 16 | + A list of tags defined by the customer. At most 40 entries are allowed per policy. |
| 17 | + :param policy_name: str (optional) |
| 18 | + The name of the policy. - Must be unique among active policies. - Can contain only characters of |
| 19 | + 0-9, a-z, A-Z, -, =, ., :, /, @, _, +, whitespace. |
| 20 | + :param request_id: str (optional) |
| 21 | + A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is |
| 22 | + recommended. This request is only idempotent if a `request_id` is provided. |
| 23 | + |
| 24 | + :returns: :class:`BudgetPolicy` |
| 25 | + |
26 | 26 |
|
27 | 27 | .. py:method:: delete(policy_id: str)
|
28 | 28 |
|
29 | 29 | Delete a budget policy.
|
30 |
| - |
31 |
| -Deletes a policy |
32 |
| - |
33 |
| -:param policy_id: str |
34 |
| - The Id of the policy. |
35 |
| - |
36 |
| - |
37 |
| - |
| 30 | + |
| 31 | + Deletes a policy |
| 32 | + |
| 33 | + :param policy_id: str |
| 34 | + The Id of the policy. |
| 35 | + |
| 36 | + |
| 37 | + |
38 | 38 |
|
39 | 39 | .. py:method:: get(policy_id: str) -> BudgetPolicy
|
40 | 40 |
|
41 | 41 | Get a budget policy.
|
42 |
| - |
43 |
| -Retrieves a policy by it's ID. |
44 |
| - |
45 |
| -:param policy_id: str |
46 |
| - The Id of the policy. |
47 |
| - |
48 |
| -:returns: :class:`BudgetPolicy` |
49 |
| - |
| 42 | + |
| 43 | + Retrieves a policy by it's ID. |
| 44 | + |
| 45 | + :param policy_id: str |
| 46 | + The Id of the policy. |
| 47 | + |
| 48 | + :returns: :class:`BudgetPolicy` |
| 49 | + |
50 | 50 |
|
51 | 51 | .. py:method:: list( [, filter_by: Optional[Filter], page_size: Optional[int], page_token: Optional[str], sort_spec: Optional[SortSpec]]) -> Iterator[BudgetPolicy]
|
52 | 52 |
|
53 | 53 | List policies.
|
54 |
| - |
55 |
| -Lists all policies. Policies are returned in the alphabetically ascending order of their names. |
56 |
| - |
57 |
| -:param filter_by: :class:`Filter` (optional) |
58 |
| - A filter to apply to the list of policies. |
59 |
| -:param page_size: int (optional) |
60 |
| - The maximum number of budget policies to return. If unspecified, at most 100 budget policies will be |
61 |
| - returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
62 |
| -:param page_token: str (optional) |
63 |
| - A page token, received from a previous `ListServerlessPolicies` call. Provide this to retrieve the |
64 |
| - subsequent page. If unspecified, the first page will be returned. |
65 |
| - |
66 |
| - When paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match the |
67 |
| - call that provided the page token. |
68 |
| -:param sort_spec: :class:`SortSpec` (optional) |
69 |
| - The sort specification. |
70 |
| - |
71 |
| -:returns: Iterator over :class:`BudgetPolicy` |
72 |
| - |
| 54 | + |
| 55 | + Lists all policies. Policies are returned in the alphabetically ascending order of their names. |
| 56 | + |
| 57 | + :param filter_by: :class:`Filter` (optional) |
| 58 | + A filter to apply to the list of policies. |
| 59 | + :param page_size: int (optional) |
| 60 | + The maximum number of budget policies to return. If unspecified, at most 100 budget policies will be |
| 61 | + returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| 62 | + :param page_token: str (optional) |
| 63 | + A page token, received from a previous `ListServerlessPolicies` call. Provide this to retrieve the |
| 64 | + subsequent page. If unspecified, the first page will be returned. |
| 65 | + |
| 66 | + When paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match the |
| 67 | + call that provided the page token. |
| 68 | + :param sort_spec: :class:`SortSpec` (optional) |
| 69 | + The sort specification. |
| 70 | + |
| 71 | + :returns: Iterator over :class:`BudgetPolicy` |
| 72 | + |
73 | 73 |
|
74 | 74 | .. py:method:: update(policy_id: str [, limit_config: Optional[LimitConfig], policy: Optional[BudgetPolicy]]) -> BudgetPolicy
|
75 | 75 |
|
76 | 76 | Update a budget policy.
|
77 |
| - |
78 |
| -Updates a policy |
79 |
| - |
80 |
| -:param policy_id: str |
81 |
| - The Id of the policy. This field is generated by Databricks and globally unique. |
82 |
| -:param limit_config: :class:`LimitConfig` (optional) |
83 |
| - DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy |
84 |
| -:param policy: :class:`BudgetPolicy` (optional) |
85 |
| - Contains the BudgetPolicy details. |
86 |
| - |
87 |
| -:returns: :class:`BudgetPolicy` |
| 77 | + |
| 78 | + Updates a policy |
| 79 | + |
| 80 | + :param policy_id: str |
| 81 | + The Id of the policy. This field is generated by Databricks and globally unique. |
| 82 | + :param limit_config: :class:`LimitConfig` (optional) |
| 83 | + DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy |
| 84 | + :param policy: :class:`BudgetPolicy` (optional) |
| 85 | + Contains the BudgetPolicy details. |
| 86 | + |
| 87 | + :returns: :class:`BudgetPolicy` |
| 88 | + |
0 commit comments