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

yandex/cloud/mdb/mysql/v1alpha/user_service_pb2.pyi

@@ -0,0 +1,312 @@
+"""
+@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.message
+import typing
+import yandex.cloud.mdb.mysql.v1alpha.user_pb2
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class GetUserRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster."""
+    user_name: builtins.str
+    """Name of the user."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_name", b"user_name"]) -> None: ...
+
+global___GetUserRequest = GetUserRequest
+
+@typing.final
+class ListUsersRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    PAGE_SIZE_FIELD_NUMBER: builtins.int
+    PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the cluster to list MySQL users in. To get the cluster ID, use a [ClusterService.List] request."""
+    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 [ListUsersResponse.next_page_token] that can be used to get the next page of results in subsequent list requests."""
+    page_token: builtins.str
+    """Page token. To get the next page of results, set [page_token] to the [ListUsersResponse.next_page_token] returned by the previous list request."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        page_size: builtins.int = ...,
+        page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "page_size", b"page_size", "page_token", b"page_token"]) -> None: ...
+
+global___ListUsersRequest = ListUsersRequest
+
+@typing.final
+class ListUsersResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    USERS_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 [ListUsersRequest.page_size], use the [next_page_token] as the value for the [ListUsersRequest.page_token] 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 users(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.mdb.mysql.v1alpha.user_pb2.User]:
+        """Requested list of MySQL users."""
+
+    def __init__(
+        self,
+        *,
+        users: collections.abc.Iterable[yandex.cloud.mdb.mysql.v1alpha.user_pb2.User] | None = ...,
+        next_page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["next_page_token", b"next_page_token", "users", b"users"]) -> None: ...
+
+global___ListUsersResponse = ListUsersResponse
+
+@typing.final
+class CreateUserRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_SPEC_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster to create a user for. To get the cluster ID, use a [ClusterService.List] request."""
+    @property
+    def user_spec(self) -> yandex.cloud.mdb.mysql.v1alpha.user_pb2.UserSpec:
+        """Properties of the user to be created."""
+
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_spec: yandex.cloud.mdb.mysql.v1alpha.user_pb2.UserSpec | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["user_spec", b"user_spec"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_spec", b"user_spec"]) -> None: ...
+
+global___CreateUserRequest = CreateUserRequest
+
+@typing.final
+class CreateUserMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user is being created for."""
+    user_name: builtins.str
+    """Name of the user that is being created."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_name", b"user_name"]) -> None: ...
+
+global___CreateUserMetadata = CreateUserMetadata
+
+@typing.final
+class UpdateUserRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    UPDATE_MASK_FIELD_NUMBER: builtins.int
+    PASSWORD_FIELD_NUMBER: builtins.int
+    PERMISSIONS_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request."""
+    user_name: builtins.str
+    """Name of the user to be updated. To get the name of the user, use a [UserService.List] request."""
+    password: builtins.str
+    """New password for the user."""
+    @property
+    def update_mask(self) -> google.protobuf.field_mask_pb2.FieldMask:
+        """Field mask that specifies which settings of the MySQL user should be updated."""
+
+    @property
+    def permissions(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.mdb.mysql.v1alpha.user_pb2.Permission]:
+        """New set of permissions for the user."""
+
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+        update_mask: google.protobuf.field_mask_pb2.FieldMask | None = ...,
+        password: builtins.str = ...,
+        permissions: collections.abc.Iterable[yandex.cloud.mdb.mysql.v1alpha.user_pb2.Permission] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["update_mask", b"update_mask"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "password", b"password", "permissions", b"permissions", "update_mask", b"update_mask", "user_name", b"user_name"]) -> None: ...
+
+global___UpdateUserRequest = UpdateUserRequest
+
+@typing.final
+class UpdateUserMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to."""
+    user_name: builtins.str
+    """Name of a user that is being updated."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_name", b"user_name"]) -> None: ...
+
+global___UpdateUserMetadata = UpdateUserMetadata
+
+@typing.final
+class DeleteUserRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request."""
+    user_name: builtins.str
+    """Name of the user to delete. To get the name of the user, use a [UserService.List] request."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_name", b"user_name"]) -> None: ...
+
+global___DeleteUserRequest = DeleteUserRequest
+
+@typing.final
+class DeleteUserMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to."""
+    user_name: builtins.str
+    """Name of the user that is being deleted."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_name", b"user_name"]) -> None: ...
+
+global___DeleteUserMetadata = DeleteUserMetadata
+
+@typing.final
+class GrantUserPermissionRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    PERMISSION_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request."""
+    user_name: builtins.str
+    """Name of the user to grant the permission to. To get the name of the user, use a [UserService.List] request."""
+    @property
+    def permission(self) -> yandex.cloud.mdb.mysql.v1alpha.user_pb2.Permission:
+        """Permission that should be granted to the specified user."""
+
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+        permission: yandex.cloud.mdb.mysql.v1alpha.user_pb2.Permission | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["permission", b"permission"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "permission", b"permission", "user_name", b"user_name"]) -> None: ...
+
+global___GrantUserPermissionRequest = GrantUserPermissionRequest
+
+@typing.final
+class GrantUserPermissionMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request."""
+    user_name: builtins.str
+    """Name of the user that is being granted a permission."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_name", b"user_name"]) -> None: ...
+
+global___GrantUserPermissionMetadata = GrantUserPermissionMetadata
+
+@typing.final
+class RevokeUserPermissionRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    DATABASE_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request."""
+    user_name: builtins.str
+    """Name of the user to revoke a permission from. To get the name of the user, use a [UserService.List] request."""
+    database_name: builtins.str
+    """Name of the database that the user should lose access to."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+        database_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "database_name", b"database_name", "user_name", b"user_name"]) -> None: ...
+
+global___RevokeUserPermissionRequest = RevokeUserPermissionRequest
+
+@typing.final
+class RevokeUserPermissionMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CLUSTER_ID_FIELD_NUMBER: builtins.int
+    USER_NAME_FIELD_NUMBER: builtins.int
+    cluster_id: builtins.str
+    """ID of the MySQL cluster the user belongs to."""
+    user_name: builtins.str
+    """Name of the user whose permission is being revoked."""
+    def __init__(
+        self,
+        *,
+        cluster_id: builtins.str = ...,
+        user_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["cluster_id", b"cluster_id", "user_name", b"user_name"]) -> None: ...
+
+global___RevokeUserPermissionMetadata = RevokeUserPermissionMetadata

yandex/cloud/mdb/opensearch/v1/auth_pb2.pyi

@@ -0,0 +1,69 @@
+"""
+@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 AuthSettings(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    SAML_FIELD_NUMBER: builtins.int
+    @property
+    def saml(self) -> global___SAMLSettings:
+        """SAML settings"""
+
+    def __init__(
+        self,
+        *,
+        saml: global___SAMLSettings | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["saml", b"saml"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["saml", b"saml"]) -> None: ...
+
+global___AuthSettings = AuthSettings
+
+@typing.final
+class SAMLSettings(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ENABLED_FIELD_NUMBER: builtins.int
+    IDP_ENTITY_ID_FIELD_NUMBER: builtins.int
+    IDP_METADATA_FILE_FIELD_NUMBER: builtins.int
+    SP_ENTITY_ID_FIELD_NUMBER: builtins.int
+    DASHBOARDS_URL_FIELD_NUMBER: builtins.int
+    ROLES_KEY_FIELD_NUMBER: builtins.int
+    SUBJECT_KEY_FIELD_NUMBER: builtins.int
+    enabled: builtins.bool
+    idp_entity_id: builtins.str
+    """Required. The entity ID of your IdP."""
+    idp_metadata_file: builtins.bytes
+    """Required. The SAML 2.0 metadata file of your IdP."""
+    sp_entity_id: builtins.str
+    """Required. The entity ID of the service provider."""
+    dashboards_url: builtins.str
+    """Required. The OpenSearch Dashboards base URL."""
+    roles_key: builtins.str
+    """Optional. The attribute in the SAML response where the roles are stored. If not configured, no roles are used."""
+    subject_key: builtins.str
+    """Optional. The attribute in the SAML response where the subject is stored. If not configured, the NameID attribute is used."""
+    def __init__(
+        self,
+        *,
+        enabled: builtins.bool = ...,
+        idp_entity_id: builtins.str = ...,
+        idp_metadata_file: builtins.bytes = ...,
+        sp_entity_id: builtins.str = ...,
+        dashboards_url: builtins.str = ...,
+        roles_key: builtins.str = ...,
+        subject_key: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["dashboards_url", b"dashboards_url", "enabled", b"enabled", "idp_entity_id", b"idp_entity_id", "idp_metadata_file", b"idp_metadata_file", "roles_key", b"roles_key", "sp_entity_id", b"sp_entity_id", "subject_key", b"subject_key"]) -> None: ...
+
+global___SAMLSettings = SAMLSettings

yandex/cloud/mdb/opensearch/v1/backup_pb2.pyi

@@ -0,0 +1,69 @@
+"""
+@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 Backup(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ID_FIELD_NUMBER: builtins.int
+    FOLDER_ID_FIELD_NUMBER: builtins.int
+    SOURCE_CLUSTER_ID_FIELD_NUMBER: builtins.int
+    STARTED_AT_FIELD_NUMBER: builtins.int
+    CREATED_AT_FIELD_NUMBER: builtins.int
+    INDICES_FIELD_NUMBER: builtins.int
+    OPENSEARCH_VERSION_FIELD_NUMBER: builtins.int
+    SIZE_BYTES_FIELD_NUMBER: builtins.int
+    INDICES_TOTAL_FIELD_NUMBER: builtins.int
+    id: builtins.str
+    """Required. ID of the backup."""
+    folder_id: builtins.str
+    """ID of the folder that the backup belongs to."""
+    source_cluster_id: builtins.str
+    """ID of the OpenSearch cluster that the backup was created for."""
+    opensearch_version: builtins.str
+    """OpenSearch version used to create the backup."""
+    size_bytes: builtins.int
+    """Size of the backup in bytes."""
+    indices_total: builtins.int
+    """The number of indices in the backup."""
+    @property
+    def started_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
+        """Time when the backup operation was started."""
+
+    @property
+    def created_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
+        """Time when the backup operation was completed."""
+
+    @property
+    def indices(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Names of indices in the backup."""
+
+    def __init__(
+        self,
+        *,
+        id: builtins.str = ...,
+        folder_id: builtins.str = ...,
+        source_cluster_id: builtins.str = ...,
+        started_at: google.protobuf.timestamp_pb2.Timestamp | None = ...,
+        created_at: google.protobuf.timestamp_pb2.Timestamp | None = ...,
+        indices: collections.abc.Iterable[builtins.str] | None = ...,
+        opensearch_version: builtins.str = ...,
+        size_bytes: builtins.int = ...,
+        indices_total: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["created_at", b"created_at", "started_at", b"started_at"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["created_at", b"created_at", "folder_id", b"folder_id", "id", b"id", "indices", b"indices", "indices_total", b"indices_total", "opensearch_version", b"opensearch_version", "size_bytes", b"size_bytes", "source_cluster_id", b"source_cluster_id", "started_at", b"started_at"]) -> None: ...
+
+global___Backup = Backup

yandex/cloud/mdb/opensearch/v1/backup_service_pb2.pyi

@@ -0,0 +1,91 @@
+"""
+@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.mdb.opensearch.v1.backup_pb2
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class GetBackupRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    BACKUP_ID_FIELD_NUMBER: builtins.int
+    backup_id: builtins.str
+    """ID of the backup to return."""
+    def __init__(
+        self,
+        *,
+        backup_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["backup_id", b"backup_id"]) -> None: ...
+
+global___GetBackupRequest = GetBackupRequest
+
+@typing.final
+class ListBackupsRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    FOLDER_ID_FIELD_NUMBER: builtins.int
+    PAGE_SIZE_FIELD_NUMBER: builtins.int
+    PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    folder_id: builtins.str
+    """ID of the folder to list backups in."""
+    page_size: builtins.int
+    """The maximum number of results per page that should be returned.
+
+    If the number of available results is larger than [page_size], the service returns
+    a [ListBackupsResponse.next_page_token] that can be used to get the next page of results
+    in subsequent list requests.
+
+    Default value is 100.
+    """
+    page_token: builtins.str
+    """The page token. To get the next page of results, set [page_token] to the [ListBackupsResponse.next_page_token]
+    returned by the previous list request.
+    """
+    def __init__(
+        self,
+        *,
+        folder_id: builtins.str = ...,
+        page_size: builtins.int = ...,
+        page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["folder_id", b"folder_id", "page_size", b"page_size", "page_token", b"page_token"]) -> None: ...
+
+global___ListBackupsRequest = ListBackupsRequest
+
+@typing.final
+class ListBackupsResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    BACKUPS_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 a list request.
+
+    If the number of results is larger than [ListBackupsRequest.page_size] specified in the request,
+    use the [next_page_token] as the value for the [ListBackupsRequest.page_token] parameter in the next list request.
+
+    Each subsequent ListBackups request has its own [next_page_token] to continue paging through the results.
+    """
+    @property
+    def backups(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.mdb.opensearch.v1.backup_pb2.Backup]:
+        """Requested list of backups."""
+
+    def __init__(
+        self,
+        *,
+        backups: collections.abc.Iterable[yandex.cloud.mdb.opensearch.v1.backup_pb2.Backup] | None = ...,
+        next_page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["backups", b"backups", "next_page_token", b"next_page_token"]) -> None: ...
+
+global___ListBackupsResponse = ListBackupsResponse