pulumi-github 6.11.0a1768966924__py3-none-any.whl → 6.12.0__py3-none-any.whl

pulumi_github/get_release_asset.py

@@ -0,0 +1,370 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from . import _utilities
+
+__all__ = [
+    'GetReleaseAssetResult',
+    'AwaitableGetReleaseAssetResult',
+    'get_release_asset',
+    'get_release_asset_output',
+]
+
+@pulumi.output_type
+class GetReleaseAssetResult:
+    """
+    A collection of values returned by getReleaseAsset.
+    """
+    def __init__(__self__, asset_id=None, browser_download_url=None, content_type=None, created_at=None, download_file_contents=None, file_contents=None, id=None, label=None, name=None, node_id=None, owner=None, repository=None, size=None, updated_at=None, url=None):
+        if asset_id and not isinstance(asset_id, int):
+            raise TypeError("Expected argument 'asset_id' to be a int")
+        pulumi.set(__self__, "asset_id", asset_id)
+        if browser_download_url and not isinstance(browser_download_url, str):
+            raise TypeError("Expected argument 'browser_download_url' to be a str")
+        pulumi.set(__self__, "browser_download_url", browser_download_url)
+        if content_type and not isinstance(content_type, str):
+            raise TypeError("Expected argument 'content_type' to be a str")
+        pulumi.set(__self__, "content_type", content_type)
+        if created_at and not isinstance(created_at, str):
+            raise TypeError("Expected argument 'created_at' to be a str")
+        pulumi.set(__self__, "created_at", created_at)
+        if download_file_contents and not isinstance(download_file_contents, bool):
+            raise TypeError("Expected argument 'download_file_contents' to be a bool")
+        pulumi.set(__self__, "download_file_contents", download_file_contents)
+        if file_contents and not isinstance(file_contents, str):
+            raise TypeError("Expected argument 'file_contents' to be a str")
+        pulumi.set(__self__, "file_contents", file_contents)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if label and not isinstance(label, str):
+            raise TypeError("Expected argument 'label' to be a str")
+        pulumi.set(__self__, "label", label)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if node_id and not isinstance(node_id, str):
+            raise TypeError("Expected argument 'node_id' to be a str")
+        pulumi.set(__self__, "node_id", node_id)
+        if owner and not isinstance(owner, str):
+            raise TypeError("Expected argument 'owner' to be a str")
+        pulumi.set(__self__, "owner", owner)
+        if repository and not isinstance(repository, str):
+            raise TypeError("Expected argument 'repository' to be a str")
+        pulumi.set(__self__, "repository", repository)
+        if size and not isinstance(size, int):
+            raise TypeError("Expected argument 'size' to be a int")
+        pulumi.set(__self__, "size", size)
+        if updated_at and not isinstance(updated_at, str):
+            raise TypeError("Expected argument 'updated_at' to be a str")
+        pulumi.set(__self__, "updated_at", updated_at)
+        if url and not isinstance(url, str):
+            raise TypeError("Expected argument 'url' to be a str")
+        pulumi.set(__self__, "url", url)
+
+    @_builtins.property
+    @pulumi.getter(name="assetId")
+    def asset_id(self) -> _builtins.int:
+        return pulumi.get(self, "asset_id")
+
+    @_builtins.property
+    @pulumi.getter(name="browserDownloadUrl")
+    def browser_download_url(self) -> _builtins.str:
+        """
+        Browser URL from which the release asset can be downloaded
+        """
+        return pulumi.get(self, "browser_download_url")
+
+    @_builtins.property
+    @pulumi.getter(name="contentType")
+    def content_type(self) -> _builtins.str:
+        """
+        MIME type of the asset
+        """
+        return pulumi.get(self, "content_type")
+
+    @_builtins.property
+    @pulumi.getter(name="createdAt")
+    def created_at(self) -> _builtins.str:
+        """
+        Date the asset was created
+        """
+        return pulumi.get(self, "created_at")
+
+    @_builtins.property
+    @pulumi.getter(name="downloadFileContents")
+    def download_file_contents(self) -> Optional[_builtins.bool]:
+        return pulumi.get(self, "download_file_contents")
+
+    @_builtins.property
+    @pulumi.getter(name="fileContents")
+    def file_contents(self) -> _builtins.str:
+        """
+        The base64-encoded release asset file contents (requires `download_file_contents` to be `true`)
+        """
+        return pulumi.get(self, "file_contents")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def label(self) -> _builtins.str:
+        """
+        Label for the asset
+        """
+        return pulumi.get(self, "label")
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> _builtins.str:
+        """
+        The file name of the asset
+        """
+        return pulumi.get(self, "name")
+
+    @_builtins.property
+    @pulumi.getter(name="nodeId")
+    def node_id(self) -> _builtins.str:
+        """
+        Node ID of the asset
+        """
+        return pulumi.get(self, "node_id")
+
+    @_builtins.property
+    @pulumi.getter
+    def owner(self) -> _builtins.str:
+        return pulumi.get(self, "owner")
+
+    @_builtins.property
+    @pulumi.getter
+    def repository(self) -> _builtins.str:
+        return pulumi.get(self, "repository")
+
+    @_builtins.property
+    @pulumi.getter
+    def size(self) -> _builtins.int:
+        """
+        Asset size in bytes
+        """
+        return pulumi.get(self, "size")
+
+    @_builtins.property
+    @pulumi.getter(name="updatedAt")
+    def updated_at(self) -> _builtins.str:
+        """
+        Date the asset was last updated
+        """
+        return pulumi.get(self, "updated_at")
+
+    @_builtins.property
+    @pulumi.getter
+    def url(self) -> _builtins.str:
+        """
+        URL of the asset
+        """
+        return pulumi.get(self, "url")
+
+
+class AwaitableGetReleaseAssetResult(GetReleaseAssetResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetReleaseAssetResult(
+            asset_id=self.asset_id,
+            browser_download_url=self.browser_download_url,
+            content_type=self.content_type,
+            created_at=self.created_at,
+            download_file_contents=self.download_file_contents,
+            file_contents=self.file_contents,
+            id=self.id,
+            label=self.label,
+            name=self.name,
+            node_id=self.node_id,
+            owner=self.owner,
+            repository=self.repository,
+            size=self.size,
+            updated_at=self.updated_at,
+            url=self.url)
+
+
+def get_release_asset(asset_id: Optional[_builtins.int] = None,
+                      download_file_contents: Optional[_builtins.bool] = None,
+                      owner: Optional[_builtins.str] = None,
+                      repository: Optional[_builtins.str] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetReleaseAssetResult:
+    """
+    Use this data source to retrieve information about a GitHub release asset.
+
+    ## Example Usage
+
+    To retrieve a specific release asset from a repository based on its ID:
+
+    ```python
+    import pulumi
+    import pulumi_github as github
+
+    example = github.get_release_asset(repository="example-repository",
+        owner="example-owner",
+        asset_id=12345)
+    ```
+
+    To retrieve a specific release asset from a repository, and download the file
+    into a `file` attribute on the data source:
+
+    To retrieve the first release asset associated with the latest release in a repository:
+
+    ```python
+    import pulumi
+    import pulumi_github as github
+
+    example = github.get_release(repository="example-repository",
+        owner="example-owner",
+        retrieve_by="latest")
+    example_get_release_asset = github.get_release_asset(repository="example-repository",
+        owner="example-owner",
+        asset_id=example.assets[0].id)
+    ```
+
+    To retrieve all release assets associated with the the latest release in a repository:
+
+    ```python
+    import pulumi
+    import pulumi_github as github
+
+    example = github.get_release(repository="example-repository",
+        owner="example-owner",
+        retrieve_by="latest")
+    example_get_release_asset = [github.get_release_asset(repository="example-repository",
+        owner="example-owner",
+        asset_id=example.assets[__index].id) for __index in len(example.assets).apply(lambda length: range(length))]
+    ```
+
+
+    :param _builtins.int asset_id: ID of the release asset to retrieve
+    :param _builtins.bool download_file_contents: Whether to download the asset file content into the `file_contents` attribute (defaults to `false`)
+    :param _builtins.str owner: Owner of the repository
+    :param _builtins.str repository: Name of the repository to retrieve the release from
+    """
+    __args__ = dict()
+    __args__['assetId'] = asset_id
+    __args__['downloadFileContents'] = download_file_contents
+    __args__['owner'] = owner
+    __args__['repository'] = repository
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('github:index/getReleaseAsset:getReleaseAsset', __args__, opts=opts, typ=GetReleaseAssetResult).value
+
+    return AwaitableGetReleaseAssetResult(
+        asset_id=pulumi.get(__ret__, 'asset_id'),
+        browser_download_url=pulumi.get(__ret__, 'browser_download_url'),
+        content_type=pulumi.get(__ret__, 'content_type'),
+        created_at=pulumi.get(__ret__, 'created_at'),
+        download_file_contents=pulumi.get(__ret__, 'download_file_contents'),
+        file_contents=pulumi.get(__ret__, 'file_contents'),
+        id=pulumi.get(__ret__, 'id'),
+        label=pulumi.get(__ret__, 'label'),
+        name=pulumi.get(__ret__, 'name'),
+        node_id=pulumi.get(__ret__, 'node_id'),
+        owner=pulumi.get(__ret__, 'owner'),
+        repository=pulumi.get(__ret__, 'repository'),
+        size=pulumi.get(__ret__, 'size'),
+        updated_at=pulumi.get(__ret__, 'updated_at'),
+        url=pulumi.get(__ret__, 'url'))
+def get_release_asset_output(asset_id: Optional[pulumi.Input[_builtins.int]] = None,
+                             download_file_contents: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                             owner: Optional[pulumi.Input[_builtins.str]] = None,
+                             repository: Optional[pulumi.Input[_builtins.str]] = None,
+                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetReleaseAssetResult]:
+    """
+    Use this data source to retrieve information about a GitHub release asset.
+
+    ## Example Usage
+
+    To retrieve a specific release asset from a repository based on its ID:
+
+    ```python
+    import pulumi
+    import pulumi_github as github
+
+    example = github.get_release_asset(repository="example-repository",
+        owner="example-owner",
+        asset_id=12345)
+    ```
+
+    To retrieve a specific release asset from a repository, and download the file
+    into a `file` attribute on the data source:
+
+    To retrieve the first release asset associated with the latest release in a repository:
+
+    ```python
+    import pulumi
+    import pulumi_github as github
+
+    example = github.get_release(repository="example-repository",
+        owner="example-owner",
+        retrieve_by="latest")
+    example_get_release_asset = github.get_release_asset(repository="example-repository",
+        owner="example-owner",
+        asset_id=example.assets[0].id)
+    ```
+
+    To retrieve all release assets associated with the the latest release in a repository:
+
+    ```python
+    import pulumi
+    import pulumi_github as github
+
+    example = github.get_release(repository="example-repository",
+        owner="example-owner",
+        retrieve_by="latest")
+    example_get_release_asset = [github.get_release_asset(repository="example-repository",
+        owner="example-owner",
+        asset_id=example.assets[__index].id) for __index in len(example.assets).apply(lambda length: range(length))]
+    ```
+
+
+    :param _builtins.int asset_id: ID of the release asset to retrieve
+    :param _builtins.bool download_file_contents: Whether to download the asset file content into the `file_contents` attribute (defaults to `false`)
+    :param _builtins.str owner: Owner of the repository
+    :param _builtins.str repository: Name of the repository to retrieve the release from
+    """
+    __args__ = dict()
+    __args__['assetId'] = asset_id
+    __args__['downloadFileContents'] = download_file_contents
+    __args__['owner'] = owner
+    __args__['repository'] = repository
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('github:index/getReleaseAsset:getReleaseAsset', __args__, opts=opts, typ=GetReleaseAssetResult)
+    return __ret__.apply(lambda __response__: GetReleaseAssetResult(
+        asset_id=pulumi.get(__response__, 'asset_id'),
+        browser_download_url=pulumi.get(__response__, 'browser_download_url'),
+        content_type=pulumi.get(__response__, 'content_type'),
+        created_at=pulumi.get(__response__, 'created_at'),
+        download_file_contents=pulumi.get(__response__, 'download_file_contents'),
+        file_contents=pulumi.get(__response__, 'file_contents'),
+        id=pulumi.get(__response__, 'id'),
+        label=pulumi.get(__response__, 'label'),
+        name=pulumi.get(__response__, 'name'),
+        node_id=pulumi.get(__response__, 'node_id'),
+        owner=pulumi.get(__response__, 'owner'),
+        repository=pulumi.get(__response__, 'repository'),
+        size=pulumi.get(__response__, 'size'),
+        updated_at=pulumi.get(__response__, 'updated_at'),
+        url=pulumi.get(__response__, 'url')))

pulumi_github/organization_ruleset.py

@@ -33,7 +33,7 @@ class OrganizationRulesetArgs:
         :param pulumi.Input['OrganizationRulesetRulesArgs'] rules: (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
         :param pulumi.Input[_builtins.str] target: (String) Possible values are `branch`, `tag` and `push`.
         :param pulumi.Input[Sequence[pulumi.Input['OrganizationRulesetBypassActorArgs']]] bypass_actors: (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
-        :param pulumi.Input['OrganizationRulesetConditionsArgs'] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. `ref_name` is required alongside one of `repository_name` or `repository_id`. (see below for nested schema)
+        :param pulumi.Input['OrganizationRulesetConditionsArgs'] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. For `branch` and `tag` targets, `ref_name` is required alongside one of `repository_name` or `repository_id`. For `push` targets, `ref_name` must NOT be set - only `repository_name` or `repository_id` should be used. (see below for nested schema)
         :param pulumi.Input[_builtins.str] name: (String) The name of the ruleset.
         """
         pulumi.set(__self__, "enforcement", enforcement)
@@ -98,7 +98,7 @@ class OrganizationRulesetArgs:
     @pulumi.getter
     def conditions(self) -> Optional[pulumi.Input['OrganizationRulesetConditionsArgs']]:
         """
-        (Block List, Max: 1) Parameters for an organization ruleset condition. `ref_name` is required alongside one of `repository_name` or `repository_id`. (see below for nested schema)
+        (Block List, Max: 1) Parameters for an organization ruleset condition. For `branch` and `tag` targets, `ref_name` is required alongside one of `repository_name` or `repository_id`. For `push` targets, `ref_name` must NOT be set - only `repository_name` or `repository_id` should be used. (see below for nested schema)
         """
         return pulumi.get(self, "conditions")
 
@@ -134,7 +134,7 @@ class _OrganizationRulesetState:
         """
         Input properties used for looking up and filtering OrganizationRuleset resources.
         :param pulumi.Input[Sequence[pulumi.Input['OrganizationRulesetBypassActorArgs']]] bypass_actors: (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
-        :param pulumi.Input['OrganizationRulesetConditionsArgs'] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. `ref_name` is required alongside one of `repository_name` or `repository_id`. (see below for nested schema)
+        :param pulumi.Input['OrganizationRulesetConditionsArgs'] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. For `branch` and `tag` targets, `ref_name` is required alongside one of `repository_name` or `repository_id`. For `push` targets, `ref_name` must NOT be set - only `repository_name` or `repository_id` should be used. (see below for nested schema)
         :param pulumi.Input[_builtins.str] enforcement: (String) Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`.
         :param pulumi.Input[_builtins.str] etag: (String)
         :param pulumi.Input[_builtins.str] name: (String) The name of the ruleset.
@@ -178,7 +178,7 @@ class _OrganizationRulesetState:
     @pulumi.getter
     def conditions(self) -> Optional[pulumi.Input['OrganizationRulesetConditionsArgs']]:
         """
-        (Block List, Max: 1) Parameters for an organization ruleset condition. `ref_name` is required alongside one of `repository_name` or `repository_id`. (see below for nested schema)
+        (Block List, Max: 1) Parameters for an organization ruleset condition. For `branch` and `tag` targets, `ref_name` is required alongside one of `repository_name` or `repository_id`. For `push` targets, `ref_name` must NOT be set - only `repository_name` or `repository_id` should be used. (see below for nested schema)
         """
         return pulumi.get(self, "conditions")
 
@@ -338,16 +338,13 @@ class OrganizationRuleset(pulumi.CustomResource):
                     }],
                 },
             })
-        # Example with push ruleset  
+        # Example with push ruleset
+        # Note: Push targets must NOT have ref_name in conditions, only repository_name or repository_id
         example_push = github.OrganizationRuleset("example_push",
             name="example_push",
             target="push",
             enforcement="active",
             conditions={
-                "ref_name": {
-                    "includes": ["~ALL"],
-                    "excludes": [],
-                },
                 "repository_name": {
                     "includes": ["~ALL"],
                     "excludes": [],
@@ -387,7 +384,7 @@ class OrganizationRuleset(pulumi.CustomResource):
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Sequence[pulumi.Input[Union['OrganizationRulesetBypassActorArgs', 'OrganizationRulesetBypassActorArgsDict']]]] bypass_actors: (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
-        :param pulumi.Input[Union['OrganizationRulesetConditionsArgs', 'OrganizationRulesetConditionsArgsDict']] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. `ref_name` is required alongside one of `repository_name` or `repository_id`. (see below for nested schema)
+        :param pulumi.Input[Union['OrganizationRulesetConditionsArgs', 'OrganizationRulesetConditionsArgsDict']] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. For `branch` and `tag` targets, `ref_name` is required alongside one of `repository_name` or `repository_id`. For `push` targets, `ref_name` must NOT be set - only `repository_name` or `repository_id` should be used. (see below for nested schema)
         :param pulumi.Input[_builtins.str] enforcement: (String) Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`.
         :param pulumi.Input[_builtins.str] name: (String) The name of the ruleset.
         :param pulumi.Input[Union['OrganizationRulesetRulesArgs', 'OrganizationRulesetRulesArgsDict']] rules: (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
@@ -453,16 +450,13 @@ class OrganizationRuleset(pulumi.CustomResource):
                     }],
                 },
             })
-        # Example with push ruleset  
+        # Example with push ruleset
+        # Note: Push targets must NOT have ref_name in conditions, only repository_name or repository_id
         example_push = github.OrganizationRuleset("example_push",
             name="example_push",
             target="push",
             enforcement="active",
             conditions={
-                "ref_name": {
-                    "includes": ["~ALL"],
-                    "excludes": [],
-                },
                 "repository_name": {
                     "includes": ["~ALL"],
                     "excludes": [],
@@ -571,7 +565,7 @@ class OrganizationRuleset(pulumi.CustomResource):
         :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Sequence[pulumi.Input[Union['OrganizationRulesetBypassActorArgs', 'OrganizationRulesetBypassActorArgsDict']]]] bypass_actors: (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
-        :param pulumi.Input[Union['OrganizationRulesetConditionsArgs', 'OrganizationRulesetConditionsArgsDict']] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. `ref_name` is required alongside one of `repository_name` or `repository_id`. (see below for nested schema)
+        :param pulumi.Input[Union['OrganizationRulesetConditionsArgs', 'OrganizationRulesetConditionsArgsDict']] conditions: (Block List, Max: 1) Parameters for an organization ruleset condition. For `branch` and `tag` targets, `ref_name` is required alongside one of `repository_name` or `repository_id`. For `push` targets, `ref_name` must NOT be set - only `repository_name` or `repository_id` should be used. (see below for nested schema)
         :param pulumi.Input[_builtins.str] enforcement: (String) Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`.
         :param pulumi.Input[_builtins.str] etag: (String)
         :param pulumi.Input[_builtins.str] name: (String) The name of the ruleset.
@@ -607,7 +601,7 @@ class OrganizationRuleset(pulumi.CustomResource):
     @pulumi.getter
     def conditions(self) -> pulumi.Output[Optional['outputs.OrganizationRulesetConditions']]:
         """
-        (Block List, Max: 1) Parameters for an organization ruleset condition. `ref_name` is required alongside one of `repository_name` or `repository_id`. (see below for nested schema)
+        (Block List, Max: 1) Parameters for an organization ruleset condition. For `branch` and `tag` targets, `ref_name` is required alongside one of `repository_name` or `repository_id`. For `push` targets, `ref_name` must NOT be set - only `repository_name` or `repository_id` should be used. (see below for nested schema)
         """
         return pulumi.get(self, "conditions")