|
| 1 | +""" |
| 2 | +@generated by mypy-protobuf. Do not edit manually! |
| 3 | +isort:skip_file |
| 4 | +""" |
| 5 | + |
| 6 | +import builtins |
| 7 | +import collections.abc |
| 8 | +import google.protobuf.descriptor |
| 9 | +import google.protobuf.internal.containers |
| 10 | +import google.protobuf.message |
| 11 | +import typing |
| 12 | +import yandex.cloud.baremetal.v1alpha.standard_image_pb2 |
| 13 | + |
| 14 | +DESCRIPTOR: google.protobuf.descriptor.FileDescriptor |
| 15 | + |
| 16 | +@typing.final |
| 17 | +class GetStandardImageRequest(google.protobuf.message.Message): |
| 18 | + DESCRIPTOR: google.protobuf.descriptor.Descriptor |
| 19 | + |
| 20 | + STANDARD_IMAGE_ID_FIELD_NUMBER: builtins.int |
| 21 | + standard_image_id: builtins.str |
| 22 | + """ID of the StandardImage resource to return. |
| 23 | +
|
| 24 | + To get the standard image ID, use a [StandardImageService.List] request. |
| 25 | + """ |
| 26 | + def __init__( |
| 27 | + self, |
| 28 | + *, |
| 29 | + standard_image_id: builtins.str = ..., |
| 30 | + ) -> None: ... |
| 31 | + def ClearField(self, field_name: typing.Literal["standard_image_id", b"standard_image_id"]) -> None: ... |
| 32 | + |
| 33 | +global___GetStandardImageRequest = GetStandardImageRequest |
| 34 | + |
| 35 | +@typing.final |
| 36 | +class ListStandardImagesRequest(google.protobuf.message.Message): |
| 37 | + DESCRIPTOR: google.protobuf.descriptor.Descriptor |
| 38 | + |
| 39 | + PAGE_SIZE_FIELD_NUMBER: builtins.int |
| 40 | + PAGE_TOKEN_FIELD_NUMBER: builtins.int |
| 41 | + ORDER_BY_FIELD_NUMBER: builtins.int |
| 42 | + FILTER_FIELD_NUMBER: builtins.int |
| 43 | + FOLDER_ID_FIELD_NUMBER: builtins.int |
| 44 | + page_size: builtins.int |
| 45 | + """The maximum number of results per page to return. If the number of available |
| 46 | + results is greater than `page_size`, |
| 47 | + the service returns a [ListStandardImagesResponse.next_page_token] |
| 48 | + that can be used to get the next page of results in subsequent list requests. |
| 49 | + Default value is 20. |
| 50 | + """ |
| 51 | + page_token: builtins.str |
| 52 | + """Page token. To get the next page of results, set `page_token` to the |
| 53 | + [ListStandardImagesResponse.next_page_token] returned by a previous list request. |
| 54 | + """ |
| 55 | + order_by: builtins.str |
| 56 | + """By which column the listing should be ordered and in which direction, |
| 57 | + format is "createdAt desc". "id asc" if omitted. |
| 58 | + Supported fields: ["id", "name"]. |
| 59 | + Both snake_case and camelCase are supported for fields. |
| 60 | + """ |
| 61 | + filter: builtins.str |
| 62 | + """A filter expression that filters resources listed in the response. |
| 63 | + The expression consists of one or more conditions united by `AND` operator: `<condition1> [AND <condition2> [<...> AND <conditionN>]]`. |
| 64 | +
|
| 65 | + Each condition has the form `<field> <operator> <value>`, where: |
| 66 | + 1. `<field>` is the field name. Currently you can use filtering only on the limited number of fields. |
| 67 | + 2. `<operator>` is a logical operator, one of `=` (equal), `:` (substring). |
| 68 | + 3. `<value>` represents a value. |
| 69 | + String values should be written in double (`"`) or single (`'`) quotes. C-style escape sequences are supported (`\\"` turns to `"`, `\\'` to `'`, `\\\\` to backslash). |
| 70 | + Example: "key1='value' AND key2='value'" |
| 71 | + Supported operators: ["AND"]. |
| 72 | + Supported fields: ["id", "name"]. |
| 73 | + Both snake_case and camelCase are supported for fields. |
| 74 | + """ |
| 75 | + folder_id: builtins.str |
| 76 | + """ID of the folder to return a StandardImage resource for. |
| 77 | +
|
| 78 | + To get the folder ID, use a [yandex.cloud.resourcemanager.v1.FolderService.List] request. Pass the "baremetal-standard-images" folder to get general images. |
| 79 | + """ |
| 80 | + def __init__( |
| 81 | + self, |
| 82 | + *, |
| 83 | + page_size: builtins.int = ..., |
| 84 | + page_token: builtins.str = ..., |
| 85 | + order_by: builtins.str = ..., |
| 86 | + filter: builtins.str = ..., |
| 87 | + folder_id: builtins.str = ..., |
| 88 | + ) -> None: ... |
| 89 | + def ClearField(self, field_name: typing.Literal["filter", b"filter", "folder_id", b"folder_id", "order_by", b"order_by", "page_size", b"page_size", "page_token", b"page_token"]) -> None: ... |
| 90 | + |
| 91 | +global___ListStandardImagesRequest = ListStandardImagesRequest |
| 92 | + |
| 93 | +@typing.final |
| 94 | +class ListStandardImagesResponse(google.protobuf.message.Message): |
| 95 | + DESCRIPTOR: google.protobuf.descriptor.Descriptor |
| 96 | + |
| 97 | + STANDARD_IMAGES_FIELD_NUMBER: builtins.int |
| 98 | + NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int |
| 99 | + next_page_token: builtins.str |
| 100 | + """Token for getting the next page of the list. If the number of results is greater than |
| 101 | + [ListStandardImagesRequest.page_size], use `next_page_token` as the value |
| 102 | + for the [ListStandardImagesRequest.page_token] parameter in the next list request. |
| 103 | +
|
| 104 | + Each subsequent page will have its own `next_page_token` to continue paging through the results. |
| 105 | + """ |
| 106 | + @property |
| 107 | + def standard_images(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.baremetal.v1alpha.standard_image_pb2.StandardImage]: |
| 108 | + """List of StandardImage resources.""" |
| 109 | + |
| 110 | + def __init__( |
| 111 | + self, |
| 112 | + *, |
| 113 | + standard_images: collections.abc.Iterable[yandex.cloud.baremetal.v1alpha.standard_image_pb2.StandardImage] | None = ..., |
| 114 | + next_page_token: builtins.str = ..., |
| 115 | + ) -> None: ... |
| 116 | + def ClearField(self, field_name: typing.Literal["next_page_token", b"next_page_token", "standard_images", b"standard_images"]) -> None: ... |
| 117 | + |
| 118 | +global___ListStandardImagesResponse = ListStandardImagesResponse |
0 commit comments