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

yandex/cloud/cdn/v1/origin_group_service_pb2.pyi

@@ -0,0 +1,252 @@
+"""
+@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.wrappers_pb2
+import typing
+import yandex.cloud.cdn.v1.origin_group_pb2
+import yandex.cloud.cdn.v1.origin_pb2
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class GetOriginGroupRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    FOLDER_ID_FIELD_NUMBER: builtins.int
+    ORIGIN_GROUP_ID_FIELD_NUMBER: builtins.int
+    folder_id: builtins.str
+    """ID of the folder that the origin group belongs to."""
+    origin_group_id: builtins.int
+    """ID of the origin group to return.
+
+    To get a origin group ID, make a [OriginGroupService.List] request.
+    """
+    def __init__(
+        self,
+        *,
+        folder_id: builtins.str = ...,
+        origin_group_id: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["folder_id", b"folder_id", "origin_group_id", b"origin_group_id"]) -> None: ...
+
+global___GetOriginGroupRequest = GetOriginGroupRequest
+
+@typing.final
+class ListOriginGroupsRequest(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 that the origin group belongs to.."""
+    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 [ListOriginGroupsResponse.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 [ListOriginGroupsResponse.next_page_token]
+    returned by a 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___ListOriginGroupsRequest = ListOriginGroupsRequest
+
+@typing.final
+class ListOriginGroupsResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ORIGIN_GROUPS_FIELD_NUMBER: builtins.int
+    NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    next_page_token: builtins.str
+    """[next_page_token] token allows you to get the next page of results for list requests.
+    If the number of results is larger than [ListOriginGroupsRequest.page_size], use
+    the [next_page_token] as the value for the [ListOriginGroupsRequest.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 origin_groups(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.cdn.v1.origin_group_pb2.OriginGroup]:
+        """List of all Origin Groups associated with folder."""
+
+    def __init__(
+        self,
+        *,
+        origin_groups: collections.abc.Iterable[yandex.cloud.cdn.v1.origin_group_pb2.OriginGroup] | None = ...,
+        next_page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["next_page_token", b"next_page_token", "origin_groups", b"origin_groups"]) -> None: ...
+
+global___ListOriginGroupsResponse = ListOriginGroupsResponse
+
+@typing.final
+class CreateOriginGroupRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    FOLDER_ID_FIELD_NUMBER: builtins.int
+    NAME_FIELD_NUMBER: builtins.int
+    USE_NEXT_FIELD_NUMBER: builtins.int
+    ORIGINS_FIELD_NUMBER: builtins.int
+    folder_id: builtins.str
+    """ID of the folder that the origin group belongs to."""
+    name: builtins.str
+    """Name of the origin group."""
+    @property
+    def use_next(self) -> google.protobuf.wrappers_pb2.BoolValue:
+        """This option have two possible conditions:
+         true - The option is active. In case the origin responds with 4XX or 5XX codes,
+                use the next origin from the list.
+         false - The option is disabled.
+
+         default value is true
+        """
+
+    @property
+    def origins(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.cdn.v1.origin_pb2.OriginParams]:
+        """List of origins: IP addresses or Domain names of your origins and the port
+        (if custom).
+        """
+
+    def __init__(
+        self,
+        *,
+        folder_id: builtins.str = ...,
+        name: builtins.str = ...,
+        use_next: google.protobuf.wrappers_pb2.BoolValue | None = ...,
+        origins: collections.abc.Iterable[yandex.cloud.cdn.v1.origin_pb2.OriginParams] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["use_next", b"use_next"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["folder_id", b"folder_id", "name", b"name", "origins", b"origins", "use_next", b"use_next"]) -> None: ...
+
+global___CreateOriginGroupRequest = CreateOriginGroupRequest
+
+@typing.final
+class CreateOriginGroupMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ORIGIN_GROUP_ID_FIELD_NUMBER: builtins.int
+    origin_group_id: builtins.int
+    """ID of created origin group."""
+    def __init__(
+        self,
+        *,
+        origin_group_id: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["origin_group_id", b"origin_group_id"]) -> None: ...
+
+global___CreateOriginGroupMetadata = CreateOriginGroupMetadata
+
+@typing.final
+class UpdateOriginGroupRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    FOLDER_ID_FIELD_NUMBER: builtins.int
+    ORIGIN_GROUP_ID_FIELD_NUMBER: builtins.int
+    GROUP_NAME_FIELD_NUMBER: builtins.int
+    USE_NEXT_FIELD_NUMBER: builtins.int
+    ORIGINS_FIELD_NUMBER: builtins.int
+    folder_id: builtins.str
+    """ID of the folder that the origin group belongs to."""
+    origin_group_id: builtins.int
+    """ID of the origin group."""
+    @property
+    def group_name(self) -> google.protobuf.wrappers_pb2.StringValue:
+        """Name of the origin group."""
+
+    @property
+    def use_next(self) -> google.protobuf.wrappers_pb2.BoolValue:
+        """This option have two possible values:
+
+          True - The option is active. In case the origin responds with 4XX or 5XX
+                 codes, use the next origin from the list.
+          False - The option is disabled.
+        """
+
+    @property
+    def origins(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.cdn.v1.origin_pb2.OriginParams]:
+        """List of origins: IP addresses or Domain names of your origins and the port
+        (if custom).
+        """
+
+    def __init__(
+        self,
+        *,
+        folder_id: builtins.str = ...,
+        origin_group_id: builtins.int = ...,
+        group_name: google.protobuf.wrappers_pb2.StringValue | None = ...,
+        use_next: google.protobuf.wrappers_pb2.BoolValue | None = ...,
+        origins: collections.abc.Iterable[yandex.cloud.cdn.v1.origin_pb2.OriginParams] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["group_name", b"group_name", "use_next", b"use_next"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["folder_id", b"folder_id", "group_name", b"group_name", "origin_group_id", b"origin_group_id", "origins", b"origins", "use_next", b"use_next"]) -> None: ...
+
+global___UpdateOriginGroupRequest = UpdateOriginGroupRequest
+
+@typing.final
+class UpdateOriginGroupMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ORIGIN_GROUP_ID_FIELD_NUMBER: builtins.int
+    origin_group_id: builtins.int
+    """ID of the origin group."""
+    def __init__(
+        self,
+        *,
+        origin_group_id: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["origin_group_id", b"origin_group_id"]) -> None: ...
+
+global___UpdateOriginGroupMetadata = UpdateOriginGroupMetadata
+
+@typing.final
+class DeleteOriginGroupRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    FOLDER_ID_FIELD_NUMBER: builtins.int
+    ORIGIN_GROUP_ID_FIELD_NUMBER: builtins.int
+    folder_id: builtins.str
+    """ID of the folder that the origin group belongs to."""
+    origin_group_id: builtins.int
+    """ID of the origin group."""
+    def __init__(
+        self,
+        *,
+        folder_id: builtins.str = ...,
+        origin_group_id: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["folder_id", b"folder_id", "origin_group_id", b"origin_group_id"]) -> None: ...
+
+global___DeleteOriginGroupRequest = DeleteOriginGroupRequest
+
+@typing.final
+class DeleteOriginGroupMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ORIGIN_GROUP_ID_FIELD_NUMBER: builtins.int
+    origin_group_id: builtins.int
+    """ID of the origin group."""
+    def __init__(
+        self,
+        *,
+        origin_group_id: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["origin_group_id", b"origin_group_id"]) -> None: ...
+
+global___DeleteOriginGroupMetadata = DeleteOriginGroupMetadata

yandex/cloud/cdn/v1/origin_pb2.pyi

@@ -0,0 +1,186 @@
+"""
+@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 Origin(google.protobuf.message.Message):
+    """An origin. For details about the concept, see [documentation](/docs/cdn/concepts/origins)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ID_FIELD_NUMBER: builtins.int
+    ORIGIN_GROUP_ID_FIELD_NUMBER: builtins.int
+    SOURCE_FIELD_NUMBER: builtins.int
+    ENABLED_FIELD_NUMBER: builtins.int
+    BACKUP_FIELD_NUMBER: builtins.int
+    META_FIELD_NUMBER: builtins.int
+    id: builtins.int
+    """ID of the origin."""
+    origin_group_id: builtins.int
+    """ID of the parent origin group."""
+    source: builtins.str
+    """IP address or Domain name of your origin and the port (if custom).
+    Used if [meta] variant is `common`.
+    """
+    enabled: builtins.bool
+    """The setting allows to enable or disable an Origin source in the Origins group.
+
+    It has two possible values:
+
+    True - The origin is enabled and used as a source for the CDN. An origins
+    group must contain at least one enabled origin. 
+    False - The origin is disabled and the CDN is not using it to pull content.
+    """
+    backup: builtins.bool
+    """Specifies whether the origin is used in its origin group as backup. 
+    A backup origin is used when one of active origins becomes unavailable.
+    """
+    @property
+    def meta(self) -> global___OriginMeta:
+        """Set up origin of the content."""
+
+    def __init__(
+        self,
+        *,
+        id: builtins.int = ...,
+        origin_group_id: builtins.int = ...,
+        source: builtins.str = ...,
+        enabled: builtins.bool = ...,
+        backup: builtins.bool = ...,
+        meta: global___OriginMeta | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["meta", b"meta"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["backup", b"backup", "enabled", b"enabled", "id", b"id", "meta", b"meta", "origin_group_id", b"origin_group_id", "source", b"source"]) -> None: ...
+
+global___Origin = Origin
+
+@typing.final
+class OriginParams(google.protobuf.message.Message):
+    """Origin parameters. For details about the concept, see [documentation](/docs/cdn/concepts/origins)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    SOURCE_FIELD_NUMBER: builtins.int
+    ENABLED_FIELD_NUMBER: builtins.int
+    BACKUP_FIELD_NUMBER: builtins.int
+    META_FIELD_NUMBER: builtins.int
+    source: builtins.str
+    """Source: IP address or Domain name of your origin and the port (if custom)."""
+    enabled: builtins.bool
+    """The setting allows to enable or disable an Origin source in the Origins group.
+
+    It has two possible values:
+
+    True - The origin is enabled and used as a source for the CDN. An origins
+    group must contain at least one enabled origins. False - The origin is disabled
+    and the CDN is not using it to pull content.
+    """
+    backup: builtins.bool
+    """backup option has two possible values:
+
+      True - The option is active. The origin will not be used until one of
+             active origins become unavailable.
+      False - The option is disabled.
+    """
+    @property
+    def meta(self) -> global___OriginMeta:
+        """Set up origin of the content."""
+
+    def __init__(
+        self,
+        *,
+        source: builtins.str = ...,
+        enabled: builtins.bool = ...,
+        backup: builtins.bool = ...,
+        meta: global___OriginMeta | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["meta", b"meta"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["backup", b"backup", "enabled", b"enabled", "meta", b"meta", "source", b"source"]) -> None: ...
+
+global___OriginParams = OriginParams
+
+@typing.final
+class OriginMeta(google.protobuf.message.Message):
+    """Origin type. For details about the concept, see [documentation](/docs/cdn/concepts/origins)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    COMMON_FIELD_NUMBER: builtins.int
+    BUCKET_FIELD_NUMBER: builtins.int
+    WEBSITE_FIELD_NUMBER: builtins.int
+    BALANCER_FIELD_NUMBER: builtins.int
+    @property
+    def common(self) -> global___OriginNamedMeta:
+        """A server with a domain name linked to it"""
+
+    @property
+    def bucket(self) -> global___OriginNamedMeta:
+        """An Object Storage bucket not configured as a static site hosting."""
+
+    @property
+    def website(self) -> global___OriginNamedMeta:
+        """An Object Storage bucket configured as a static site hosting."""
+
+    @property
+    def balancer(self) -> global___OriginBalancerMeta:
+        """An L7 load balancer from Application Load Balancer.
+        CDN servers will access the load balancer at one of its IP addresses that must be selected in the origin settings.
+        """
+
+    def __init__(
+        self,
+        *,
+        common: global___OriginNamedMeta | None = ...,
+        bucket: global___OriginNamedMeta | None = ...,
+        website: global___OriginNamedMeta | None = ...,
+        balancer: global___OriginBalancerMeta | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["balancer", b"balancer", "bucket", b"bucket", "common", b"common", "origin_meta_variant", b"origin_meta_variant", "website", b"website"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["balancer", b"balancer", "bucket", b"bucket", "common", b"common", "origin_meta_variant", b"origin_meta_variant", "website", b"website"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["origin_meta_variant", b"origin_meta_variant"]) -> typing.Literal["common", "bucket", "website", "balancer"] | None: ...
+
+global___OriginMeta = OriginMeta
+
+@typing.final
+class OriginNamedMeta(google.protobuf.message.Message):
+    """Origin info. For details about the concept, see [documentation](/docs/cdn/concepts/origins)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    NAME_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    """Name of the origin."""
+    def __init__(
+        self,
+        *,
+        name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["name", b"name"]) -> None: ...
+
+global___OriginNamedMeta = OriginNamedMeta
+
+@typing.final
+class OriginBalancerMeta(google.protobuf.message.Message):
+    """Application Load Balancer origin info. For details about the concept, see [documentation](/docs/cdn/concepts/origins)."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ID_FIELD_NUMBER: builtins.int
+    id: builtins.str
+    """ID of the origin."""
+    def __init__(
+        self,
+        *,
+        id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["id", b"id"]) -> None: ...
+
+global___OriginBalancerMeta = OriginBalancerMeta