yandexcloud 0.288.0__py3-none-any.whl → 0.289.0__py3-none-any.whl

yandex/cloud/iam/v1/key_service_pb2.pyi

@@ -0,0 +1,320 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.field_mask_pb2
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+import yandex.cloud.iam.v1.key_pb2
+import yandex.cloud.operation.operation_pb2
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _KeyFormat:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _KeyFormatEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_KeyFormat.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    PEM_FILE: _KeyFormat.ValueType  # 0
+    """Privacy-Enhanced Mail (PEM) format. Default value."""
+
+class KeyFormat(_KeyFormat, metaclass=_KeyFormatEnumTypeWrapper): ...
+
+PEM_FILE: KeyFormat.ValueType  # 0
+"""Privacy-Enhanced Mail (PEM) format. Default value."""
+global___KeyFormat = KeyFormat
+
+@typing.final
+class GetKeyRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEY_ID_FIELD_NUMBER: builtins.int
+    FORMAT_FIELD_NUMBER: builtins.int
+    key_id: builtins.str
+    """ID of the Key resource to return.
+    To get the ID use a [KeyService.List] request.
+    """
+    format: global___KeyFormat.ValueType
+    """Output format of the key."""
+    def __init__(
+        self,
+        *,
+        key_id: builtins.str = ...,
+        format: global___KeyFormat.ValueType = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["format", b"format", "key_id", b"key_id"]) -> None: ...
+
+global___GetKeyRequest = GetKeyRequest
+
+@typing.final
+class ListKeysRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    FORMAT_FIELD_NUMBER: builtins.int
+    SERVICE_ACCOUNT_ID_FIELD_NUMBER: builtins.int
+    PAGE_SIZE_FIELD_NUMBER: builtins.int
+    PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    format: global___KeyFormat.ValueType
+    """Output format of the key."""
+    service_account_id: builtins.str
+    """ID of the service account to list key pairs for.
+    To get the service account ID, use a [yandex.cloud.iam.v1.ServiceAccountService.List] request.
+    If not specified, it defaults to the subject that made the request.
+    use userAccount identity if this not set
+    """
+    page_size: builtins.int
+    """The maximum number of results per page to return. If the number of available
+    results is larger than [page_size],
+    the service returns a [ListKeysResponse.next_page_token]
+    that can be used to get the next page of results in subsequent list requests.
+    Default value: 100.
+    """
+    page_token: builtins.str
+    """Page token. To get the next page of results, set [page_token] to the
+    [ListKeysResponse.next_page_token] returned by a previous list request.
+    """
+    def __init__(
+        self,
+        *,
+        format: global___KeyFormat.ValueType = ...,
+        service_account_id: builtins.str = ...,
+        page_size: builtins.int = ...,
+        page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["format", b"format", "page_size", b"page_size", "page_token", b"page_token", "service_account_id", b"service_account_id"]) -> None: ...
+
+global___ListKeysRequest = ListKeysRequest
+
+@typing.final
+class ListKeysResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEYS_FIELD_NUMBER: builtins.int
+    NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    next_page_token: builtins.str
+    """This token allows you to get the next page of results for list requests. If the number of results
+    is larger than [ListKeysRequest.page_size], use
+    the [next_page_token] as the value
+    for the [ListKeysRequest.page_token] query parameter
+    in the next list request. Each subsequent list request will have its own
+    [next_page_token] to continue paging through the results.
+    """
+    @property
+    def keys(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.iam.v1.key_pb2.Key]:
+        """List of Key resources."""
+
+    def __init__(
+        self,
+        *,
+        keys: collections.abc.Iterable[yandex.cloud.iam.v1.key_pb2.Key] | None = ...,
+        next_page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["keys", b"keys", "next_page_token", b"next_page_token"]) -> None: ...
+
+global___ListKeysResponse = ListKeysResponse
+
+@typing.final
+class CreateKeyRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    SERVICE_ACCOUNT_ID_FIELD_NUMBER: builtins.int
+    DESCRIPTION_FIELD_NUMBER: builtins.int
+    FORMAT_FIELD_NUMBER: builtins.int
+    KEY_ALGORITHM_FIELD_NUMBER: builtins.int
+    service_account_id: builtins.str
+    """ID of the service account to create a key pair for.
+    To get the service account ID, use a [yandex.cloud.iam.v1.ServiceAccountService.List] request.
+    If not specified, it defaults to the subject that made the request.
+    use userAccount identity if this not set
+    """
+    description: builtins.str
+    """Description of the key pair."""
+    format: global___KeyFormat.ValueType
+    """Output format of the key."""
+    key_algorithm: yandex.cloud.iam.v1.key_pb2.Key.Algorithm.ValueType
+    """An algorithm used to generate a key pair of the Key resource."""
+    def __init__(
+        self,
+        *,
+        service_account_id: builtins.str = ...,
+        description: builtins.str = ...,
+        format: global___KeyFormat.ValueType = ...,
+        key_algorithm: yandex.cloud.iam.v1.key_pb2.Key.Algorithm.ValueType = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["description", b"description", "format", b"format", "key_algorithm", b"key_algorithm", "service_account_id", b"service_account_id"]) -> None: ...
+
+global___CreateKeyRequest = CreateKeyRequest
+
+@typing.final
+class CreateKeyResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEY_FIELD_NUMBER: builtins.int
+    PRIVATE_KEY_FIELD_NUMBER: builtins.int
+    private_key: builtins.str
+    """A private key of the Key resource.
+    This key must be stored securely.
+    """
+    @property
+    def key(self) -> yandex.cloud.iam.v1.key_pb2.Key:
+        """Key resource."""
+
+    def __init__(
+        self,
+        *,
+        key: yandex.cloud.iam.v1.key_pb2.Key | None = ...,
+        private_key: builtins.str = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["key", b"key"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["key", b"key", "private_key", b"private_key"]) -> None: ...
+
+global___CreateKeyResponse = CreateKeyResponse
+
+@typing.final
+class UpdateKeyRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEY_ID_FIELD_NUMBER: builtins.int
+    UPDATE_MASK_FIELD_NUMBER: builtins.int
+    DESCRIPTION_FIELD_NUMBER: builtins.int
+    key_id: builtins.str
+    """ID of the Key resource to update.
+    To get key pair ID, use a [KeyService.List] request.
+    """
+    description: builtins.str
+    """Description of the key pair."""
+    @property
+    def update_mask(self) -> google.protobuf.field_mask_pb2.FieldMask:
+        """Field mask that specifies which fields of the Key resource are going to be updated."""
+
+    def __init__(
+        self,
+        *,
+        key_id: builtins.str = ...,
+        update_mask: google.protobuf.field_mask_pb2.FieldMask | None = ...,
+        description: builtins.str = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["update_mask", b"update_mask"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["description", b"description", "key_id", b"key_id", "update_mask", b"update_mask"]) -> None: ...
+
+global___UpdateKeyRequest = UpdateKeyRequest
+
+@typing.final
+class UpdateKeyMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEY_ID_FIELD_NUMBER: builtins.int
+    key_id: builtins.str
+    """ID of the Key resource that is being updated."""
+    def __init__(
+        self,
+        *,
+        key_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["key_id", b"key_id"]) -> None: ...
+
+global___UpdateKeyMetadata = UpdateKeyMetadata
+
+@typing.final
+class DeleteKeyRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEY_ID_FIELD_NUMBER: builtins.int
+    key_id: builtins.str
+    """ID of the key to delete.
+    To get key ID use a [KeyService.List] request.
+    """
+    def __init__(
+        self,
+        *,
+        key_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["key_id", b"key_id"]) -> None: ...
+
+global___DeleteKeyRequest = DeleteKeyRequest
+
+@typing.final
+class DeleteKeyMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEY_ID_FIELD_NUMBER: builtins.int
+    key_id: builtins.str
+    """ID of the key that is being deleted."""
+    def __init__(
+        self,
+        *,
+        key_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["key_id", b"key_id"]) -> None: ...
+
+global___DeleteKeyMetadata = DeleteKeyMetadata
+
+@typing.final
+class ListKeyOperationsRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    KEY_ID_FIELD_NUMBER: builtins.int
+    PAGE_SIZE_FIELD_NUMBER: builtins.int
+    PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    key_id: builtins.str
+    """ID of the key to list operations for."""
+    page_size: builtins.int
+    """The maximum number of results per page to return. If the number of available
+    results is larger than [page_size],
+    the service returns a [ListKeyOperationsResponse.next_page_token]
+    that can be used to get the next page of results in subsequent list requests.
+    Default value: 100.
+    """
+    page_token: builtins.str
+    """Page token. To get the next page of results, set [page_token] to the
+    [ListKeyOperationsResponse.next_page_token] returned by a previous list request.
+    """
+    def __init__(
+        self,
+        *,
+        key_id: builtins.str = ...,
+        page_size: builtins.int = ...,
+        page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["key_id", b"key_id", "page_size", b"page_size", "page_token", b"page_token"]) -> None: ...
+
+global___ListKeyOperationsRequest = ListKeyOperationsRequest
+
+@typing.final
+class ListKeyOperationsResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    OPERATIONS_FIELD_NUMBER: builtins.int
+    NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    next_page_token: builtins.str
+    """This token allows you to get the next page of results for list requests. If the number of results
+    is larger than [ListKeyOperationsRequest.page_size], use the [next_page_token] as the value
+    for the [ListKeyOperationsRequest.page_token] query parameter in the next list request.
+    Each subsequent list request will have its own [next_page_token] to continue paging through the results.
+    """
+    @property
+    def operations(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.operation.operation_pb2.Operation]:
+        """List of operations for the specified key."""
+
+    def __init__(
+        self,
+        *,
+        operations: collections.abc.Iterable[yandex.cloud.operation.operation_pb2.Operation] | None = ...,
+        next_page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["next_page_token", b"next_page_token", "operations", b"operations"]) -> None: ...
+
+global___ListKeyOperationsResponse = ListKeyOperationsResponse

yandex/cloud/iam/v1/resource_pb2.pyi

@@ -0,0 +1,33 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class Resource(google.protobuf.message.Message):
+    """A Resource. For more information, see [Resource](/docs/iam/concepts/access-control/resources-with-access-control)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ID_FIELD_NUMBER: builtins.int
+    TYPE_FIELD_NUMBER: builtins.int
+    id: builtins.str
+    """ID of the resource."""
+    type: builtins.str
+    """The type of the resource, e.g. resource-manager.folder, billing.account, compute.snapshot, etc."""
+    def __init__(
+        self,
+        *,
+        id: builtins.str = ...,
+        type: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["id", b"id", "type", b"type"]) -> None: ...
+
+global___Resource = Resource

yandex/cloud/iam/v1/role_pb2.pyi

@@ -0,0 +1,33 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class Role(google.protobuf.message.Message):
+    """A Role resource. For more information, see [Roles](/docs/iam/concepts/access-control/roles)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ID_FIELD_NUMBER: builtins.int
+    DESCRIPTION_FIELD_NUMBER: builtins.int
+    id: builtins.str
+    """ID of the role."""
+    description: builtins.str
+    """Description of the role. 0-256 characters long."""
+    def __init__(
+        self,
+        *,
+        id: builtins.str = ...,
+        description: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["description", b"description", "id", b"id"]) -> None: ...
+
+global___Role = Role

yandex/cloud/iam/v1/role_service_pb2.pyi

@@ -0,0 +1,92 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.message
+import typing
+import yandex.cloud.iam.v1.role_pb2
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class GetRoleRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ROLE_ID_FIELD_NUMBER: builtins.int
+    role_id: builtins.str
+    """ID of the Role resource to return.
+    To get the role ID, use a [RoleService.List] request.
+    """
+    def __init__(
+        self,
+        *,
+        role_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["role_id", b"role_id"]) -> None: ...
+
+global___GetRoleRequest = GetRoleRequest
+
+@typing.final
+class ListRolesRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PAGE_SIZE_FIELD_NUMBER: builtins.int
+    PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    FILTER_FIELD_NUMBER: builtins.int
+    page_size: builtins.int
+    """The maximum number of results per page to return. If the number of available
+    results is larger than [page_size],
+    the service returns a [ListRolesResponse.next_page_token]
+    that can be used to get the next page of results in subsequent list requests.
+    Default value: 100.
+    """
+    page_token: builtins.str
+    """Page token. To get the next page of results, set [page_token]
+    to the [ListRolesResponse.next_page_token]
+    returned by a previous list request.
+    """
+    filter: builtins.str
+    """A filter expression that filters resources listed in the response."""
+    def __init__(
+        self,
+        *,
+        page_size: builtins.int = ...,
+        page_token: builtins.str = ...,
+        filter: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["filter", b"filter", "page_size", b"page_size", "page_token", b"page_token"]) -> None: ...
+
+global___ListRolesRequest = ListRolesRequest
+
+@typing.final
+class ListRolesResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ROLES_FIELD_NUMBER: builtins.int
+    NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    next_page_token: builtins.str
+    """This token allows you to get the next page of results for list requests. If the number of results
+    is larger than [ListRolesRequest.page_size], use
+    the [next_page_token] as the value
+    for the [ListRolesRequest.page_token] query parameter
+    in the next list request. Each subsequent list request will have its own
+    [next_page_token] to continue paging through the results.
+    """
+    @property
+    def roles(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.iam.v1.role_pb2.Role]:
+        """List of Role resources."""
+
+    def __init__(
+        self,
+        *,
+        roles: collections.abc.Iterable[yandex.cloud.iam.v1.role_pb2.Role] | None = ...,
+        next_page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["next_page_token", b"next_page_token", "roles", b"roles"]) -> None: ...
+
+global___ListRolesResponse = ListRolesResponse

yandex/cloud/iam/v1/service_account_pb2.pyi

@@ -0,0 +1,75 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.message
+import google.protobuf.timestamp_pb2
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class ServiceAccount(google.protobuf.message.Message):
+    """A ServiceAccount resource. For more information, see [Service accounts](/docs/iam/concepts/users/service-accounts)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    @typing.final
+    class LabelsEntry(google.protobuf.message.Message):
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+        KEY_FIELD_NUMBER: builtins.int
+        VALUE_FIELD_NUMBER: builtins.int
+        key: builtins.str
+        value: builtins.str
+        def __init__(
+            self,
+            *,
+            key: builtins.str = ...,
+            value: builtins.str = ...,
+        ) -> None: ...
+        def ClearField(self, field_name: typing.Literal["key", b"key", "value", b"value"]) -> None: ...
+
+    ID_FIELD_NUMBER: builtins.int
+    FOLDER_ID_FIELD_NUMBER: builtins.int
+    CREATED_AT_FIELD_NUMBER: builtins.int
+    NAME_FIELD_NUMBER: builtins.int
+    DESCRIPTION_FIELD_NUMBER: builtins.int
+    LABELS_FIELD_NUMBER: builtins.int
+    id: builtins.str
+    """ID of the service account."""
+    folder_id: builtins.str
+    """ID of the folder that the service account belongs to."""
+    name: builtins.str
+    """Name of the service account.
+    The name is unique within the cloud. 3-63 characters long.
+    """
+    description: builtins.str
+    """Description of the service account. 0-256 characters long."""
+    @property
+    def created_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
+        """Creation timestamp."""
+
+    @property
+    def labels(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]:
+        """Resource labels as `` key:value `` pairs. Maximum of 64 per resource."""
+
+    def __init__(
+        self,
+        *,
+        id: builtins.str = ...,
+        folder_id: builtins.str = ...,
+        created_at: google.protobuf.timestamp_pb2.Timestamp | None = ...,
+        name: builtins.str = ...,
+        description: builtins.str = ...,
+        labels: collections.abc.Mapping[builtins.str, builtins.str] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["created_at", b"created_at"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["created_at", b"created_at", "description", b"description", "folder_id", b"folder_id", "id", b"id", "labels", b"labels", "name", b"name"]) -> None: ...
+
+global___ServiceAccount = ServiceAccount