Skip to content

Commit ed09bd0

Browse files
author
CBWS
committed
Update generated protobuf docs based on v0.0.10
1 parent 9726e86 commit ed09bd0

1 file changed

Lines changed: 244 additions & 0 deletions

File tree

protobuf/service-usage.md

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,244 @@
1+
# Protocol Documentation
2+
<a name="top"></a>
3+
4+
## Table of Contents
5+
6+
- [cbws/service_management/service_usage/v1alpha1/service.proto](#cbws/service_management/service_usage/v1alpha1/service.proto)
7+
- [Service](#cbws.service_management.service_usage.v1alpha1.Service)
8+
- [ServiceConfig](#cbws.service_management.service_usage.v1alpha1.ServiceConfig)
9+
10+
- [ServiceState](#cbws.service_management.service_usage.v1alpha1.ServiceState)
11+
12+
- [cbws/service_management/service_usage/v1alpha1/service_management.proto](#cbws/service_management/service_usage/v1alpha1/service_management.proto)
13+
- [DisableServiceMetadata](#cbws.service_management.service_usage.v1alpha1.DisableServiceMetadata)
14+
- [DisableServiceRequest](#cbws.service_management.service_usage.v1alpha1.DisableServiceRequest)
15+
- [DisableServiceResponse](#cbws.service_management.service_usage.v1alpha1.DisableServiceResponse)
16+
- [EnableServiceMetadata](#cbws.service_management.service_usage.v1alpha1.EnableServiceMetadata)
17+
- [EnableServiceRequest](#cbws.service_management.service_usage.v1alpha1.EnableServiceRequest)
18+
- [EnableServiceResponse](#cbws.service_management.service_usage.v1alpha1.EnableServiceResponse)
19+
- [ListServicesRequest](#cbws.service_management.service_usage.v1alpha1.ListServicesRequest)
20+
- [ListServicesResponse](#cbws.service_management.service_usage.v1alpha1.ListServicesResponse)
21+
22+
- [ServiceUsageService](#cbws.service_management.service_usage.v1alpha1.ServiceUsageService)
23+
24+
- [Scalar Value Types](#scalar-value-types)
25+
26+
27+
28+
<a name="cbws/service_management/service_usage/v1alpha1/service.proto"></a>
29+
<p align="right"><a href="#top">Top</a></p>
30+
31+
## cbws/service_management/service_usage/v1alpha1/service.proto
32+
33+
34+
35+
<a name="cbws.service_management.service_usage.v1alpha1.Service"></a>
36+
37+
### Service
38+
39+
40+
41+
| Field | Type | Label | Description |
42+
| ----- | ---- | ----- | ----------- |
43+
| name | [string](#string) | | Service relative resource name, in the format of projects/test-project/services/k8s.cbws.xyz |
44+
| parent | [string](#string) | | Relative resource name of the parent resource, for example projects/test-project |
45+
| config | [ServiceConfig](#cbws.service_management.service_usage.v1alpha1.ServiceConfig) | | Overall information about the service, including service name (k8s.cbws.xyz) and title |
46+
| state | [ServiceState](#cbws.service_management.service_usage.v1alpha1.ServiceState) | | Whether the service is enabled on this project or not |
47+
48+
49+
50+
51+
52+
53+
<a name="cbws.service_management.service_usage.v1alpha1.ServiceConfig"></a>
54+
55+
### ServiceConfig
56+
57+
58+
59+
| Field | Type | Label | Description |
60+
| ----- | ---- | ----- | ----------- |
61+
| name | [string](#string) | | The name of the service, for example k8s.cbws.xyz |
62+
| title | [string](#string) | | The title of the product of the service, for example Kubernetes |
63+
64+
65+
66+
67+
68+
69+
70+
71+
<a name="cbws.service_management.service_usage.v1alpha1.ServiceState"></a>
72+
73+
### ServiceState
74+
75+
76+
| Name | Number | Description |
77+
| ---- | ------ | ----------- |
78+
| SERVICE_STATE_UNSPECIFIED | 0 | |
79+
| SERVICE_STATE_DISABLED | 1 | Service is currently not enabled in the consumer project |
80+
| SERVICE_STATE_ENABLED | 2 | Service is enabled in the consumer project and can be used |
81+
82+
83+
84+
85+
86+
87+
88+
89+
90+
91+
<a name="cbws/service_management/service_usage/v1alpha1/service_management.proto"></a>
92+
<p align="right"><a href="#top">Top</a></p>
93+
94+
## cbws/service_management/service_usage/v1alpha1/service_management.proto
95+
96+
97+
98+
<a name="cbws.service_management.service_usage.v1alpha1.DisableServiceMetadata"></a>
99+
100+
### DisableServiceMetadata
101+
102+
103+
104+
105+
106+
107+
108+
<a name="cbws.service_management.service_usage.v1alpha1.DisableServiceRequest"></a>
109+
110+
### DisableServiceRequest
111+
Request message for DisableService method.
112+
113+
114+
| Field | Type | Label | Description |
115+
| ----- | ---- | ----- | ----------- |
116+
| name | [string](#string) | | Relative resource of service in project in format: projects/test-project/services/iam.cbws.xyz |
117+
118+
119+
120+
121+
122+
123+
<a name="cbws.service_management.service_usage.v1alpha1.DisableServiceResponse"></a>
124+
125+
### DisableServiceResponse
126+
Operation payload for DisableService method.
127+
128+
129+
130+
131+
132+
133+
<a name="cbws.service_management.service_usage.v1alpha1.EnableServiceMetadata"></a>
134+
135+
### EnableServiceMetadata
136+
137+
138+
139+
140+
141+
142+
143+
<a name="cbws.service_management.service_usage.v1alpha1.EnableServiceRequest"></a>
144+
145+
### EnableServiceRequest
146+
Request message for EnableService method.
147+
148+
149+
| Field | Type | Label | Description |
150+
| ----- | ---- | ----- | ----------- |
151+
| name | [string](#string) | | Relative resource of service in project in format: projects/test-project/services/iam.cbws.xyz |
152+
153+
154+
155+
156+
157+
158+
<a name="cbws.service_management.service_usage.v1alpha1.EnableServiceResponse"></a>
159+
160+
### EnableServiceResponse
161+
Operation payload for EnableService method.
162+
163+
164+
165+
166+
167+
168+
<a name="cbws.service_management.service_usage.v1alpha1.ListServicesRequest"></a>
169+
170+
### ListServicesRequest
171+
172+
173+
174+
| Field | Type | Label | Description |
175+
| ----- | ---- | ----- | ----------- |
176+
| parent | [string](#string) | | |
177+
178+
179+
180+
181+
182+
183+
<a name="cbws.service_management.service_usage.v1alpha1.ListServicesResponse"></a>
184+
185+
### ListServicesResponse
186+
187+
188+
189+
| Field | Type | Label | Description |
190+
| ----- | ---- | ----- | ----------- |
191+
| services | [Service](#cbws.service_management.service_usage.v1alpha1.Service) | repeated | The list of matching services. |
192+
193+
194+
195+
196+
197+
198+
199+
200+
201+
202+
203+
204+
<a name="cbws.service_management.service_usage.v1alpha1.ServiceUsageService"></a>
205+
206+
### ServiceUsageService
207+
208+
209+
| Method Name | Request Type | Response Type | Description |
210+
| ----------- | ------------ | ------------- | ------------|
211+
| ListServices | [ListServicesRequest](#cbws.service_management.service_usage.v1alpha1.ListServicesRequest) | [ListServicesResponse](#cbws.service_management.service_usage.v1alpha1.ListServicesResponse) | Enables a service for a project, so it can be used for the project.
212+
213+
Operation&lt;response: EnableServiceResponse&gt; |
214+
| EnableService | [EnableServiceRequest](#cbws.service_management.service_usage.v1alpha1.EnableServiceRequest) | [.google.longrunning.Operation](#google.longrunning.Operation) | Enables a service for a project, so it can be used for the project.
215+
216+
Operation&lt;response: EnableServiceResponse&gt; |
217+
| DisableService | [DisableServiceRequest](#cbws.service_management.service_usage.v1alpha1.DisableServiceRequest) | [.google.longrunning.Operation](#google.longrunning.Operation) | Disables a service for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks.
218+
219+
Operation&lt;response: DisableServiceResponse&gt; |
220+
221+
222+
223+
224+
225+
## Scalar Value Types
226+
227+
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
228+
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
229+
| <a name="double" /> double | | double | double | float | float64 | double | float | Float |
230+
| <a name="float" /> float | | float | float | float | float32 | float | float | Float |
231+
| <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) |
232+
| <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 |
233+
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
234+
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
235+
| <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) |
236+
| <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 |
237+
| <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) |
238+
| <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 |
239+
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
240+
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
241+
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
242+
| <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) |
243+
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
244+

0 commit comments

Comments
 (0)