blob: 8041a2b31441ead2e5d7df3f840cb729d67c42a2 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.publicAdvertisedPrefixes.html">publicAdvertisedPrefixes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070081 <code><a href="#delete">delete(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070082<p class="firstline">Deletes the specified PublicAdvertisedPrefix</p>
83<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070084 <code><a href="#get">get(project, publicAdvertisedPrefix, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070085<p class="firstline">Returns the specified PublicAdvertisedPrefix resource.</p>
86<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070087 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070088<p class="firstline">Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.</p>
89<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070090 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070091<p class="firstline">Lists the PublicAdvertisedPrefixes for a project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070096 <code><a href="#patch">patch(project, publicAdvertisedPrefix, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070097<p class="firstline">Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.</p>
98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700105 <code class="details" id="delete">delete(project, publicAdvertisedPrefix, requestId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 <pre>Deletes the specified PublicAdvertisedPrefix
107
108Args:
109 project: string, Project ID for this request. (required)
110 publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to delete. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700111 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700116
117Returns:
118 An object of the form:
119
yoshi-code-bot36591372021-06-16 00:22:06 -0700120 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800121 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
122 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
123 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
124 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
125 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
126 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
129 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
130 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700131 },
132 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 },
134 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
135 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
136 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
137 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
138 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
139 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800140 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
142 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
143 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
144 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
145 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
146 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
147 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
148 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
149 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
150 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
151 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
152 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
153 {
154 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700155 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800156 {
157 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
158 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
159 },
160 ],
161 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
162 },
163 ],
164 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
165}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700166</div>
167
168<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700169 <code class="details" id="get">get(project, publicAdvertisedPrefix, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700170 <pre>Returns the specified PublicAdvertisedPrefix resource.
171
172Args:
173 project: string, Project ID for this request. (required)
174 publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to return. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700179
180Returns:
181 An object of the form:
182
183 { # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800184 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
185 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
186 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The IPv4 address to be used for reverse DNS verification.
yoshi-code-bot36591372021-06-16 00:22:06 -0700187 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800188 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource type. The server generates this identifier.
189 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IPv4 address range, in CIDR format, represented by this public advertised prefix.
190 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
191 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
192 &quot;publicDelegatedPrefixs&quot;: [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
193 { # Represents a CIDR range which can be used to assign addresses.
194 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
195 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
196 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
197 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent, the prefix is global.
198 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.
199 },
200 ],
201 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
202 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL with id for the resource.
203 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
204 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix.
205}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700206</div>
207
208<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700209 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700210 <pre>Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
211
212Args:
213 project: string, Project ID for this request. (required)
214 body: object, The request body.
215 The object takes the form of:
216
217{ # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.
218 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
219 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
220 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The IPv4 address to be used for reverse DNS verification.
yoshi-code-bot36591372021-06-16 00:22:06 -0700221 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
Bu Sun Kim65020912020-05-20 12:08:20 -0700222 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource type. The server generates this identifier.
223 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IPv4 address range, in CIDR format, represented by this public advertised prefix.
224 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
225 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
226 &quot;publicDelegatedPrefixs&quot;: [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
227 { # Represents a CIDR range which can be used to assign addresses.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700228 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
Bu Sun Kim65020912020-05-20 12:08:20 -0700229 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700230 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
Bu Sun Kim65020912020-05-20 12:08:20 -0700231 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent, the prefix is global.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700233 },
234 ],
235 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
236 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL with id for the resource.
237 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
238 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix.
239}
240
yoshi-code-bot36591372021-06-16 00:22:06 -0700241 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700246
247Returns:
248 An object of the form:
249
yoshi-code-bot36591372021-06-16 00:22:06 -0700250 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800251 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
252 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
253 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
254 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
255 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
256 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700257 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800258 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
259 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
260 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700261 },
262 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800263 },
264 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
265 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
266 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
267 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
268 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
269 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800270 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800271 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
272 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
273 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
274 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
275 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
276 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
277 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
278 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
279 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
280 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
281 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
282 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
283 {
284 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700285 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800286 {
287 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
288 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
289 },
290 ],
291 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
292 },
293 ],
294 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
295}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700296</div>
297
298<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700299 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700300 <pre>Lists the PublicAdvertisedPrefixes for a project.
301
302Args:
303 project: string, Project ID for this request. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700304 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700305 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot36591372021-06-16 00:22:06 -0700306 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700307 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800308 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700309 x__xgafv: string, V1 error format.
310 Allowed values
311 1 - v1 error format
312 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700313
314Returns:
315 An object of the form:
316
317 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800318 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
319 &quot;items&quot;: [ # A list of PublicAdvertisedPrefix resources.
320 { # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.
321 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
322 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
323 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The IPv4 address to be used for reverse DNS verification.
yoshi-code-bot36591372021-06-16 00:22:06 -0700324 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800325 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource type. The server generates this identifier.
326 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IPv4 address range, in CIDR format, represented by this public advertised prefix.
327 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
328 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
329 &quot;publicDelegatedPrefixs&quot;: [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
330 { # Represents a CIDR range which can be used to assign addresses.
331 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
332 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
333 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
334 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent, the prefix is global.
335 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700336 },
337 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800338 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
339 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL with id for the resource.
340 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
341 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix.
Bu Sun Kim65020912020-05-20 12:08:20 -0700342 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800343 ],
344 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefixList&quot;, # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
345 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
346 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
347 &quot;warning&quot;: { # [Output Only] Informational warning message.
348 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700349 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800350 {
351 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
352 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
353 },
354 ],
355 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
356 },
357}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700358</div>
359
360<div class="method">
361 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
362 <pre>Retrieves the next page of results.
363
364Args:
365 previous_request: The request for the previous page. (required)
366 previous_response: The response from the request for the previous page. (required)
367
368Returns:
369 A request object that you can call &#x27;execute()&#x27; on to request the next
370 page. Returns None if there are no more items in the collection.
371 </pre>
372</div>
373
374<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700375 <code class="details" id="patch">patch(project, publicAdvertisedPrefix, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700376 <pre>Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
377
378Args:
379 project: string, Project ID for this request. (required)
380 publicAdvertisedPrefix: string, Name of the PublicAdvertisedPrefix resource to patch. (required)
381 body: object, The request body.
382 The object takes the form of:
383
384{ # A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.
385 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
386 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
387 &quot;dnsVerificationIp&quot;: &quot;A String&quot;, # The IPv4 address to be used for reverse DNS verification.
yoshi-code-bot36591372021-06-16 00:22:06 -0700388 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
Bu Sun Kim65020912020-05-20 12:08:20 -0700389 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource type. The server generates this identifier.
390 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IPv4 address range, in CIDR format, represented by this public advertised prefix.
391 &quot;kind&quot;: &quot;compute#publicAdvertisedPrefix&quot;, # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
392 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
393 &quot;publicDelegatedPrefixs&quot;: [ # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
394 { # Represents a CIDR range which can be used to assign addresses.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700395 &quot;ipRange&quot;: &quot;A String&quot;, # The IP address range of the public delegated prefix
Bu Sun Kim65020912020-05-20 12:08:20 -0700396 &quot;name&quot;: &quot;A String&quot;, # The name of the public delegated prefix
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700397 &quot;project&quot;: &quot;A String&quot;, # The project number of the public delegated prefix
Bu Sun Kim65020912020-05-20 12:08:20 -0700398 &quot;region&quot;: &quot;A String&quot;, # The region of the public delegated prefix if it is regional. If absent, the prefix is global.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700399 &quot;status&quot;: &quot;A String&quot;, # The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700400 },
401 ],
402 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
403 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL with id for the resource.
404 &quot;sharedSecret&quot;: &quot;A String&quot;, # [Output Only] The shared secret to be used for reverse DNS verification.
405 &quot;status&quot;: &quot;A String&quot;, # The status of the public advertised prefix.
406}
407
yoshi-code-bot36591372021-06-16 00:22:06 -0700408 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
409 x__xgafv: string, V1 error format.
410 Allowed values
411 1 - v1 error format
412 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700413
414Returns:
415 An object of the form:
416
yoshi-code-bot36591372021-06-16 00:22:06 -0700417 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800418 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
419 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
420 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
421 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
422 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
423 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700424 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800425 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
426 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
427 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700428 },
429 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800430 },
431 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
432 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
433 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
434 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
435 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
436 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800437 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800438 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
439 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
440 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
441 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
442 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
443 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
444 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
445 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
446 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
447 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
448 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
449 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
450 {
451 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700452 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800453 {
454 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
455 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
456 },
457 ],
458 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
459 },
460 ],
461 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
462}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700463</div>
464
465</body></html>