blob: 4ac7db70a25321d9a76960e21d968702fddffb14 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.licenseCodes.html">licenseCodes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project, licenseCode)</a></code></p>
79<p class="firstline">Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.</p>
80<p class="toc_element">
81 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
82<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(project, licenseCode)</code>
86 <pre>Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.
87
88Args:
89 project: string, Project ID for this request. (required)
90 licenseCode: string, Number corresponding to the License code resource to return. (required)
91
92Returns:
93 An object of the form:
94
95 {
96 "kind": "compute#licenseCode", # [Output Only] Type of resource. Always compute#licenseCode for licenses.
97 "description": "A String", # [Output Only] Description of this License Code.
98 "transferable": True or False, # [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.
99 "state": "A String", # [Output Only] Current state of this License Code.
100 "licenseAlias": [ # [Output Only] URL and description aliases of Licenses with the same License Code.
101 {
102 "description": "A String", # [Output Only] Description of this License Code.
103 "selfLink": "A String", # [Output Only] URL of license corresponding to this License Code.
104 },
105 ],
106 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
107 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
108 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
109 "name": "A String", # [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.
110 }</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
115 <pre>Returns permissions that a caller has on the specified resource.
116
117Args:
118 project: string, Project ID for this request. (required)
119 resource: string, Name or id of the resource for this request. (required)
120 body: object, The request body. (required)
121 The object takes the form of:
122
123{
124 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
125 "A String",
126 ],
127 }
128
129
130Returns:
131 An object of the form:
132
133 {
134 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
135 "A String",
136 ],
137 }</pre>
138</div>
139
140</body></html>