blob: 89ef15caabe7c5f5d46a6a31f271ab6c8d4721cd [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_v1.html">Compute Engine API</a> . <a href="compute_v1.regionSslCertificates.html">regionSslCertificates</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, region, sslCertificate, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070082<p class="firstline">Deletes the specified SslCertificate resource in the region.</p>
83<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070084 <code><a href="#get">get(project, region, sslCertificate, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070085<p class="firstline">Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.</p>
86<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070087 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070088<p class="firstline">Creates a SslCertificate resource in the specified project and region using the data 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, region, 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">Retrieves the list of SslCertificate resources available to the specified project in the specified region.</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<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700102 <code class="details" id="delete">delete(project, region, sslCertificate, requestId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700103 <pre>Deletes the specified SslCertificate resource in the region.
104
105Args:
106 project: string, Project ID for this request. (required)
107 region: string, Name of the region scoping this request. (required)
108 sslCertificate: string, Name of the SslCertificate resource to delete. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700109 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
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700114
115Returns:
116 An object of the form:
117
yoshi-code-bot36591372021-06-16 00:22:06 -0700118 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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 -0800119 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
120 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
121 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
122 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
123 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
124 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700125 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800126 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
127 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
128 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700129 },
130 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800131 },
132 &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`.
133 &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.
134 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
135 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
136 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
137 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800138 &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 -0800139 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
140 &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.
141 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
142 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
143 &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.
144 &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`.
145 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
146 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
147 &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.
148 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
149 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
150 {
151 &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 -0700152 &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 -0800153 {
154 &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).
155 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
156 },
157 ],
158 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
159 },
160 ],
161 &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.
162}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700163</div>
164
165<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700166 <code class="details" id="get">get(project, region, sslCertificate, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700167 <pre>Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.
168
169Args:
170 project: string, Project ID for this request. (required)
171 region: string, Name of the region scoping this request. (required)
172 sslCertificate: string, Name of the SslCertificate resource to return. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700177
178Returns:
179 An object of the form:
180
yoshi-code-bot36591372021-06-16 00:22:06 -0700181 { # Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers The regionSslCertificates are used by internal HTTPS load balancers. Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
183 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
184 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
185 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
186 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
187 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
188 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
189 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
190 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700191 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800192 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 &quot;A String&quot;,
194 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800195 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
196 },
197 &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.
198 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
199 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
200 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
201 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
202 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
203 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
204 },
205 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
206 &quot;A String&quot;,
207 ],
208 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fields certificate and private_key are used.
209}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700210</div>
211
212<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700213 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700214 <pre>Creates a SslCertificate resource in the specified project and region using the data included in the request
215
216Args:
217 project: string, Project ID for this request. (required)
218 region: string, Name of the region scoping this request. (required)
219 body: object, The request body.
220 The object takes the form of:
221
yoshi-code-bot36591372021-06-16 00:22:06 -0700222{ # Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers The regionSslCertificates are used by internal HTTPS load balancers. Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700223 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700224 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
225 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
226 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
227 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
228 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
229 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
230 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
231 &quot;a_key&quot;: &quot;A String&quot;,
232 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800233 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).
Bu Sun Kim65020912020-05-20 12:08:20 -0700234 &quot;A String&quot;,
235 ],
236 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
237 },
238 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700239 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700240 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
241 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
242 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
243 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
244 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
245 },
246 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
247 &quot;A String&quot;,
248 ],
249 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fields certificate and private_key are used.
250}
251
yoshi-code-bot36591372021-06-16 00:22:06 -0700252 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
253 x__xgafv: string, V1 error format.
254 Allowed values
255 1 - v1 error format
256 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700257
258Returns:
259 An object of the form:
260
yoshi-code-bot36591372021-06-16 00:22:06 -0700261 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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 -0800262 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
263 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
264 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
265 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
266 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
267 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700268 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800269 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
270 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
271 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700272 },
273 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800274 },
275 &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`.
276 &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.
277 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
278 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
279 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
280 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800281 &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 -0800282 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
283 &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.
284 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
285 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
286 &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.
287 &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`.
288 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
289 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
290 &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.
291 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
292 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
293 {
294 &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 -0700295 &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 -0800296 {
297 &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).
298 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
299 },
300 ],
301 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
302 },
303 ],
304 &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.
305}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700306</div>
307
308<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700309 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700310 <pre>Retrieves the list of SslCertificate resources available to the specified project in the specified region.
311
312Args:
313 project: string, Project ID for this request. (required)
314 region: string, Name of the region scoping this request. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700315 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 -0700316 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 -0700317 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 -0700318 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 -0800319 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 -0700320 x__xgafv: string, V1 error format.
321 Allowed values
322 1 - v1 error format
323 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700324
325Returns:
326 An object of the form:
327
328 { # Contains a list of SslCertificate resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800329 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
330 &quot;items&quot;: [ # A list of SslCertificate resources.
yoshi-code-bot36591372021-06-16 00:22:06 -0700331 { # Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers The regionSslCertificates are used by internal HTTPS load balancers. Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800332 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
333 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
334 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
335 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
336 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
337 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
338 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
339 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
340 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700341 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800342 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 &quot;A String&quot;,
344 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800345 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
346 },
347 &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.
348 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
349 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
350 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
351 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
352 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
353 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
354 },
355 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
356 &quot;A String&quot;,
357 ],
358 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fields certificate and private_key are used.
359 },
360 ],
361 &quot;kind&quot;: &quot;compute#sslCertificateList&quot;, # Type of resource.
362 &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.
363 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
364 &quot;warning&quot;: { # [Output Only] Informational warning message.
365 &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 -0700366 &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 -0800367 {
368 &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).
369 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim65020912020-05-20 12:08:20 -0700370 },
371 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800372 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
373 },
374}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700375</div>
376
377<div class="method">
378 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
379 <pre>Retrieves the next page of results.
380
381Args:
382 previous_request: The request for the previous page. (required)
383 previous_response: The response from the request for the previous page. (required)
384
385Returns:
386 A request object that you can call &#x27;execute()&#x27; on to request the next
387 page. Returns None if there are no more items in the collection.
388 </pre>
389</div>
390
391</body></html>