Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitd5a2931

Browse files
authored
docs: fix c.g.c structure (#982)
* docs: fix c.g.c structure* docs: make docs job happy
1 parent9f81bc8 commitd5a2931

File tree

9 files changed

+104
-103
lines changed

9 files changed

+104
-103
lines changed

‎docs/acl_guide.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
ACL
2+
===
3+
4+
Cloud Storage uses access control lists (ACLs) to manage object and bucket access.
5+
ACLs are the mechanism you use to share files with other users and allow
6+
other users to access your buckets and files.
7+
8+
ACLs are suitable for fine-grained control, but you may prefer using IAM to
9+
control access at the project level. See also:
10+
`Cloud Storage Control Access to Data<https://cloud.google.com/storage/docs/access-control>`_
11+
12+
13+
:class:`google.cloud.storage.bucket.Bucket` has a getting method that creates
14+
an ACL object under the hood, and you can interact with that using
15+
:func:`google.cloud.storage.bucket.Bucket.acl`:
16+
17+
..code-block::python
18+
19+
client= storage.Client()
20+
bucket= client.get_bucket(bucket_name)
21+
acl= bucket.acl
22+
23+
Adding and removing permissions can be done with the following methods
24+
(in increasing order of granularity):
25+
26+
-:func:`ACL.all`
27+
corresponds to access for all users.
28+
-:func:`ACL.all_authenticated` corresponds
29+
to access for all users that are signed into a Google account.
30+
-:func:`ACL.domain` corresponds to access on a
31+
per Google Apps domain (ie, ``example.com``).
32+
-:func:`ACL.group` corresponds to access on a
33+
per group basis (either by ID or e-mail address).
34+
-:func:`ACL.user` corresponds to access on a
35+
per user basis (either by ID or e-mail address).
36+
37+
And you are able to ``grant`` and ``revoke`` the following roles:
38+
39+
- **Reading**:
40+
:func:`_ACLEntity.grant_read` and:func:`_ACLEntity.revoke_read`
41+
- **Writing**:
42+
:func:`_ACLEntity.grant_write` and:func:`_ACLEntity.revoke_write`
43+
- **Owning**:
44+
:func:`_ACLEntity.grant_owner` and:func:`_ACLEntity.revoke_owner`
45+
46+
You can use any of these like any other factory method (these happen to
47+
be:class:`_ACLEntity` factories):
48+
49+
..code-block::python
50+
51+
acl.user("me@example.org").grant_read()
52+
acl.all_authenticated().grant_write()
53+
54+
After that, you can save any changes you make with the
55+
:func:`google.cloud.storage.acl.ACL.save` method:
56+
57+
..code-block::python
58+
59+
acl.save()
60+
61+
62+
You can alternatively save any existing:class:`google.cloud.storage.acl.ACL`
63+
object (whether it was created by a factory method or not) from a
64+
:class:`google.cloud.storage.bucket.Bucket`:
65+
66+
..code-block::python
67+
68+
bucket.acl.save(acl=acl)
69+
70+
71+
To get the list of ``entity`` and ``role`` for each unique pair, the
72+
:class:`ACL` class is iterable:
73+
74+
..code-block::python
75+
76+
print(list(acl))
77+
# [{'role': 'OWNER', 'entity': 'allUsers'}, ...]
78+
79+
80+
This list of tuples can be used as the ``entity`` and ``role`` fields
81+
when sending metadata for ACLs to the API.
82+
File renamed without changes.

‎docs/index.rst‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,31 @@
88
:class:`multiprocessing.Pool` or:class:`multiprocessing.Process` invokes
99
:func:`os.fork`.
1010

11+
Guides
12+
------
13+
..toctree::
14+
:maxdepth:2
15+
16+
acl_guide
17+
generation_metageneration
18+
retry_timeout
19+
1120
API Reference
1221
-------------
1322
..toctree::
1423
:maxdepth:2
1524

16-
storage/modules
25+
storage/acl
26+
storage/batch
27+
storage/blob
28+
storage/bucket
29+
storage/client
30+
storage/constants
31+
storage/fileio
32+
storage/hmac_key
33+
storage/notification
34+
storage/retry
35+
1736

1837
More Examples
1938
-------------
File renamed without changes.
File renamed without changes.

‎docs/storage/acl.rst‎

Lines changed: 1 addition & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,5 @@
1-
ACL
2-
===
3-
4-
Cloud Storage uses access control lists (ACLs) to manage object and bucket access.
5-
ACLs are the mechanism you use to share files with other users and allow
6-
other users to access your buckets and files.
7-
8-
ACLs are suitable for fine-grained control, but you may prefer using IAM to
9-
control access at the project level. See also:
10-
`Cloud Storage Control Access to Data<https://cloud.google.com/storage/docs/access-control>`_
11-
12-
13-
:class:`google.cloud.storage.bucket.Bucket` has a getting method that creates
14-
an ACL object under the hood, and you can interact with that using
15-
:func:`google.cloud.storage.bucket.Bucket.acl`:
16-
17-
..code-block::python
18-
19-
client= storage.Client()
20-
bucket= client.get_bucket(bucket_name)
21-
acl= bucket.acl
22-
23-
Adding and removing permissions can be done with the following methods
24-
(in increasing order of granularity):
25-
26-
-:func:`ACL.all`
27-
corresponds to access for all users.
28-
-:func:`ACL.all_authenticated` corresponds
29-
to access for all users that are signed into a Google account.
30-
-:func:`ACL.domain` corresponds to access on a
31-
per Google Apps domain (ie, ``example.com``).
32-
-:func:`ACL.group` corresponds to access on a
33-
per group basis (either by ID or e-mail address).
34-
-:func:`ACL.user` corresponds to access on a
35-
per user basis (either by ID or e-mail address).
36-
37-
And you are able to ``grant`` and ``revoke`` the following roles:
38-
39-
- **Reading**:
40-
:func:`_ACLEntity.grant_read` and:func:`_ACLEntity.revoke_read`
41-
- **Writing**:
42-
:func:`_ACLEntity.grant_write` and:func:`_ACLEntity.revoke_write`
43-
- **Owning**:
44-
:func:`_ACLEntity.grant_owner` and:func:`_ACLEntity.revoke_owner`
45-
46-
You can use any of these like any other factory method (these happen to
47-
be:class:`_ACLEntity` factories):
48-
49-
..code-block::python
50-
51-
acl.user("me@example.org").grant_read()
52-
acl.all_authenticated().grant_write()
53-
54-
After that, you can save any changes you make with the
55-
:func:`google.cloud.storage.acl.ACL.save` method:
56-
57-
..code-block::python
58-
59-
acl.save()
60-
61-
62-
You can alternatively save any existing:class:`google.cloud.storage.acl.ACL`
63-
object (whether it was created by a factory method or not) from a
64-
:class:`google.cloud.storage.bucket.Bucket`:
65-
66-
..code-block::python
67-
68-
bucket.acl.save(acl=acl)
69-
70-
71-
To get the list of ``entity`` and ``role`` for each unique pair, the
72-
:class:`ACL` class is iterable:
73-
74-
..code-block::python
75-
76-
print(list(acl))
77-
# [{'role': 'OWNER', 'entity': 'allUsers'}, ...]
78-
79-
80-
This list of tuples can be used as the ``entity`` and ``role`` fields
81-
when sending metadata for ACLs to the API.
82-
83-
841
ACL Module
85-
----------
2+
-----------
863

874
..automodule::google.cloud.storage.acl
885
:members:
File renamed without changes.

‎docs/storage/buckets.rst‎renamed to ‎docs/storage/bucket.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Buckets
1+
Bucket
22
~~~~~~~
33

44
..automodule::google.cloud.storage.bucket

‎docs/storage/modules.rst‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp