Skip to content

Commit 8df8024

Browse files
author
CBWS
committed
Update generated protobuf docs based on v0.0.11
1 parent 4cb1fe6 commit 8df8024

1 file changed

Lines changed: 197 additions & 0 deletions

File tree

‎protobuf/projects.md‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
# Protocol Documentation
2+
<a name="top"></a>
3+
4+
## Table of Contents
5+
6+
- [cbws/projects/v1alpha1/project.proto](#cbws/projects/v1alpha1/project.proto)
7+
- [Project](#cbws.projects.v1alpha1.Project)
8+
9+
- [cbws/projects/v1alpha1/projects.proto](#cbws/projects/v1alpha1/projects.proto)
10+
- [CreateProjectRequest](#cbws.projects.v1alpha1.CreateProjectRequest)
11+
- [DeleteProjectMetadata](#cbws.projects.v1alpha1.DeleteProjectMetadata)
12+
- [DeleteProjectRequest](#cbws.projects.v1alpha1.DeleteProjectRequest)
13+
- [GetProjectRequest](#cbws.projects.v1alpha1.GetProjectRequest)
14+
- [ListProjectsRequest](#cbws.projects.v1alpha1.ListProjectsRequest)
15+
- [ListProjectsResponse](#cbws.projects.v1alpha1.ListProjectsResponse)
16+
17+
- [ProjectsService](#cbws.projects.v1alpha1.ProjectsService)
18+
19+
- [Scalar Value Types](#scalar-value-types)
20+
21+
22+
23+
<a name="cbws/projects/v1alpha1/project.proto"></a>
24+
<p align="right"><a href="#top">Top</a></p>
25+
26+
## cbws/projects/v1alpha1/project.proto
27+
28+
29+
30+
<a name="cbws.projects.v1alpha1.Project"></a>
31+
32+
### Project
33+
34+
35+
36+
| Field | Type | Label | Description |
37+
| ----- | ---- | ----- | ----------- |
38+
| name | [string](#string) | | The name of the project in the format: projects/test-project |
39+
| display_name | [string](#string) | | |
40+
| organization | [string](#string) | | @OutputOnly The id of the project that owns the service account. |
41+
| unique_id | [string](#string) | | @OutputOnly The UUID of the project |
42+
43+
44+
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
<a name="cbws/projects/v1alpha1/projects.proto"></a>
58+
<p align="right"><a href="#top">Top</a></p>
59+
60+
## cbws/projects/v1alpha1/projects.proto
61+
62+
63+
64+
<a name="cbws.projects.v1alpha1.CreateProjectRequest"></a>
65+
66+
### CreateProjectRequest
67+
68+
69+
70+
| Field | Type | Label | Description |
71+
| ----- | ---- | ----- | ----------- |
72+
| parent | [string](#string) | | |
73+
| name | [string](#string) | | Required. The name of the project, It is globally unique across CBWS, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. |
74+
| project | [Project](#cbws.projects.v1alpha1.Project) | | The [Project][cbws.projects.v1alpha1.Project] resource to create. Currently, only the following values are user assignable: `display_name`. |
75+
76+
77+
78+
79+
80+
81+
<a name="cbws.projects.v1alpha1.DeleteProjectMetadata"></a>
82+
83+
### DeleteProjectMetadata
84+
85+
86+
87+
88+
89+
90+
91+
<a name="cbws.projects.v1alpha1.DeleteProjectRequest"></a>
92+
93+
### DeleteProjectRequest
94+
The project delete request.
95+
96+
97+
| Field | Type | Label | Description |
98+
| ----- | ---- | ----- | ----------- |
99+
| name | [string](#string) | | The name of the project in format projects/project-name |
100+
101+
102+
103+
104+
105+
106+
<a name="cbws.projects.v1alpha1.GetProjectRequest"></a>
107+
108+
### GetProjectRequest
109+
110+
111+
112+
| Field | Type | Label | Description |
113+
| ----- | ---- | ----- | ----------- |
114+
| name | [string](#string) | | |
115+
116+
117+
118+
119+
120+
121+
<a name="cbws.projects.v1alpha1.ListProjectsRequest"></a>
122+
123+
### ListProjectsRequest
124+
The service account list request.
125+
126+
127+
| Field | Type | Label | Description |
128+
| ----- | ---- | ----- | ----------- |
129+
| page_size | [int32](#int32) | | Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the [ListServiceAccountsResponse.next_page_token][google.iam.admin.v1.ListServiceAccountsResponse.next_page_token] in a subsequent request. |
130+
| page_token | [string](#string) | | Optional pagination token returned in an earlier [ListServiceAccountsResponse.next_page_token][google.iam.admin.v1.ListServiceAccountsResponse.next_page_token]. |
131+
132+
133+
134+
135+
136+
137+
<a name="cbws.projects.v1alpha1.ListProjectsResponse"></a>
138+
139+
### ListProjectsResponse
140+
141+
142+
143+
| Field | Type | Label | Description |
144+
| ----- | ---- | ----- | ----------- |
145+
| projects | [Project](#cbws.projects.v1alpha1.Project) | repeated | |
146+
| next_page_token | [string](#string) | | To retrieve the next page of results, set [ListServiceAccountsRequest.page_token][google.iam.admin.v1.ListServiceAccountsRequest.page_token] to this value. |
147+
148+
149+
150+
151+
152+
153+
154+
155+
156+
157+
158+
159+
<a name="cbws.projects.v1alpha1.ProjectsService"></a>
160+
161+
### ProjectsService
162+
163+
164+
| Method Name | Request Type | Response Type | Description |
165+
| ----------- | ------------ | ------------- | ------------|
166+
| CreateProject | [CreateProjectRequest](#cbws.projects.v1alpha1.CreateProjectRequest) | [Project](#cbws.projects.v1alpha1.Project) | Create a project, requires the projects.cbws.xyz/Project/create permission on the organization. The principal creating a project will get the owner role on the project. |
167+
| ListProjects | [ListProjectsRequest](#cbws.projects.v1alpha1.ListProjectsRequest) | [ListProjectsResponse](#cbws.projects.v1alpha1.ListProjectsResponse) | List all projects you have access to Requires the projects.cbws.xyz/Project/get permission on the project |
168+
| GetProject | [GetProjectRequest](#cbws.projects.v1alpha1.GetProjectRequest) | [Project](#cbws.projects.v1alpha1.Project) | |
169+
| DeleteProject | [DeleteProjectRequest](#cbws.projects.v1alpha1.DeleteProjectRequest) | [.google.longrunning.Operation](#google.longrunning.Operation) | |
170+
| GetPolicy | [.cbws.iam.policy.v1alpha1.GetPolicyRequest](#cbws.iam.policy.v1alpha1.GetPolicyRequest) | [.cbws.iam.policy.v1alpha1.Policy](#cbws.iam.policy.v1alpha1.Policy) | Returns the IAM access control policy for a Project. |
171+
| SetPolicy | [.cbws.iam.policy.v1alpha1.SetPolicyRequest](#cbws.iam.policy.v1alpha1.SetPolicyRequest) | [.cbws.iam.policy.v1alpha1.Policy](#cbws.iam.policy.v1alpha1.Policy) | Sets the IAM access control policy for a Project. |
172+
| TestPermissions | [.cbws.iam.policy.v1alpha1.TestPermissionsRequest](#cbws.iam.policy.v1alpha1.TestPermissionsRequest) | [.cbws.iam.policy.v1alpha1.TestPermissionsResponse](#cbws.iam.policy.v1alpha1.TestPermissionsResponse) | Tests the specified permissions against the IAM access control policy for a Project. |
173+
174+
175+
176+
177+
178+
## Scalar Value Types
179+
180+
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
181+
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
182+
| <a name="double" /> double | | double | double | float | float64 | double | float | Float |
183+
| <a name="float" /> float | | float | float | float | float32 | float | float | Float |
184+
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
185+
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
186+
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
187+
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
188+
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
189+
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
190+
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
191+
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
192+
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
193+
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
194+
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
195+
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
196+
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
197+

0 commit comments

Comments
 (0)