Skip to content

Commit 8f7ad0d

Browse files
feat(privateca): update the api
#### privateca:v1 The following keys were added: - resources.projects.resources.locations.resources.caPools.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.caPools.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.caPools.methods.fetchCaCerts (Total Keys: 12) - resources.projects.resources.locations.resources.caPools.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.caPools.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.caPools.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.activate (Total Keys: 12) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.delete (Total Keys: 15) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.disable (Total Keys: 12) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.enable (Total Keys: 12) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.fetch (Total Keys: 11) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.methods.undelete (Total Keys: 12) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.resources.certificateRevocationLists.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.resources.certificateRevocationLists.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.caPools.resources.certificateAuthorities.resources.certificateRevocationLists.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.caPools.resources.certificates.methods.create (Total Keys: 20) - resources.projects.resources.locations.resources.caPools.resources.certificates.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.caPools.resources.certificates.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.caPools.resources.certificates.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.caPools.resources.certificates.methods.revoke (Total Keys: 12) - resources.projects.resources.locations.resources.certificateTemplates.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.certificateTemplates.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.certificateTemplates.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.certificateTemplates.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.certificateTemplates.methods.patch (Total Keys: 17) - schemas.ActivateCertificateAuthorityRequest (Total Keys: 5) - schemas.AllowedKeyType (Total Keys: 4) - schemas.CaOptions (Total Keys: 5) - schemas.CaPool (Total Keys: 9) - schemas.CertChain (Total Keys: 4) - schemas.Certificate (Total Keys: 112) - schemas.DisableCertificateAuthorityRequest (Total Keys: 3) - schemas.EcKeyType (Total Keys: 3) - schemas.EnableCertificateAuthorityRequest (Total Keys: 3) - schemas.ExtendedKeyUsageOptions (Total Keys: 8) - schemas.FetchCaCertsRequest (Total Keys: 3) - schemas.FetchCaCertsResponse (Total Keys: 4) - schemas.FetchCertificateAuthorityCsrResponse (Total Keys: 4) - schemas.IssuanceModes (Total Keys: 4) - schemas.IssuancePolicy (Total Keys: 10) - schemas.KeyId (Total Keys: 3) - schemas.KeyUsage (Total Keys: 17) - schemas.KeyVersionSpec (Total Keys: 4) - schemas.ListCaPoolsResponse (Total Keys: 7) - schemas.ListCertificateAuthoritiesResponse (Total Keys: 7) - schemas.ListCertificateRevocationListsResponse (Total Keys: 7) - schemas.ListCertificateTemplatesResponse (Total Keys: 7) - schemas.ListCertificatesResponse (Total Keys: 7) - schemas.ObjectId (Total Keys: 5) - schemas.PublicKey (Total Keys: 5) - schemas.PublishingOptions (Total Keys: 4) - schemas.RevocationDetails (Total Keys: 5) - schemas.RevokeCertificateRequest (Total Keys: 4) - schemas.RevokedCertificate (Total Keys: 5) - schemas.RsaKeyType (Total Keys: 6) - schemas.Subject (Total Keys: 26) - schemas.SubordinateConfig (Total Keys: 8) - schemas.UndeleteCertificateAuthorityRequest (Total Keys: 3) - schemas.X509Extension (Total Keys: 6) - schemas.X509Parameters (Total Keys: 10)
1 parent d3b0073 commit 8f7ad0d

6 files changed

+7140
-51
lines changed

docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.certificateRevocationLists.html

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,21 @@ <h2>Instance Methods</h2>
7777
<p class="toc_element">
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Returns a CertificateRevocationList.</p>
8083
<p class="toc_element">
8184
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
8285
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
86+
<p class="toc_element">
87+
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Lists CertificateRevocationLists.</p>
89+
<p class="toc_element">
90+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91+
<p class="firstline">Retrieves the next page of results.</p>
92+
<p class="toc_element">
93+
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
94+
<p class="firstline">Update a CertificateRevocationList.</p>
8395
<p class="toc_element">
8496
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
8597
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
@@ -92,6 +104,42 @@ <h3>Method Details</h3>
92104
<pre>Close httplib2 connections.</pre>
93105
</div>
94106

107+
<div class="method">
108+
<code class="details" id="get">get(name, x__xgafv=None)</code>
109+
<pre>Returns a CertificateRevocationList.
110+
111+
Args:
112+
name: string, Required. The name of the CertificateRevocationList to get. (required)
113+
x__xgafv: string, V1 error format.
114+
Allowed values
115+
1 - v1 error format
116+
2 - v2 error format
117+
118+
Returns:
119+
An object of the form:
120+
121+
{ # A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.
122+
&quot;accessUrl&quot;: &quot;A String&quot;, # Output only. The location where &#x27;pem_crl&#x27; can be accessed.
123+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CertificateRevocationList was created.
124+
&quot;labels&quot;: { # Optional. Labels with user-defined metadata.
125+
&quot;a_key&quot;: &quot;A String&quot;,
126+
},
127+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`.
128+
&quot;pemCrl&quot;: &quot;A String&quot;, # Output only. The PEM-encoded X.509 CRL.
129+
&quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of this CertificateRevocationList. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string.
130+
&quot;revokedCertificates&quot;: [ # Output only. The revoked serial numbers that appear in pem_crl.
131+
{ # Describes a revoked Certificate.
132+
&quot;certificate&quot;: &quot;A String&quot;, # The resource name for the Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
133+
&quot;hexSerialNumber&quot;: &quot;A String&quot;, # The serial number of the Certificate.
134+
&quot;revocationReason&quot;: &quot;A String&quot;, # The reason the Certificate was revoked.
135+
},
136+
],
137+
&quot;sequenceNumber&quot;: &quot;A String&quot;, # Output only. The CRL sequence number that appears in pem_crl.
138+
&quot;state&quot;: &quot;A String&quot;, # Output only. The State for this CertificateRevocationList.
139+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time at which this CertificateRevocationList was updated.
140+
}</pre>
141+
</div>
142+
95143
<div class="method">
96144
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
97145
<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -140,6 +188,129 @@ <h3>Method Details</h3>
140188
}</pre>
141189
</div>
142190

191+
<div class="method">
192+
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
193+
<pre>Lists CertificateRevocationLists.
194+
195+
Args:
196+
parent: string, Required. The resource name of the location associated with the CertificateRevocationLists, in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)
197+
filter: string, Optional. Only include resources that match the filter in the response.
198+
orderBy: string, Optional. Specify how the results should be sorted.
199+
pageSize: integer, Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
200+
pageToken: string, Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.
201+
x__xgafv: string, V1 error format.
202+
Allowed values
203+
1 - v1 error format
204+
2 - v2 error format
205+
206+
Returns:
207+
An object of the form:
208+
209+
{ # Response message for CertificateAuthorityService.ListCertificateRevocationLists.
210+
&quot;certificateRevocationLists&quot;: [ # The list of CertificateRevocationLists.
211+
{ # A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.
212+
&quot;accessUrl&quot;: &quot;A String&quot;, # Output only. The location where &#x27;pem_crl&#x27; can be accessed.
213+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CertificateRevocationList was created.
214+
&quot;labels&quot;: { # Optional. Labels with user-defined metadata.
215+
&quot;a_key&quot;: &quot;A String&quot;,
216+
},
217+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`.
218+
&quot;pemCrl&quot;: &quot;A String&quot;, # Output only. The PEM-encoded X.509 CRL.
219+
&quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of this CertificateRevocationList. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string.
220+
&quot;revokedCertificates&quot;: [ # Output only. The revoked serial numbers that appear in pem_crl.
221+
{ # Describes a revoked Certificate.
222+
&quot;certificate&quot;: &quot;A String&quot;, # The resource name for the Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
223+
&quot;hexSerialNumber&quot;: &quot;A String&quot;, # The serial number of the Certificate.
224+
&quot;revocationReason&quot;: &quot;A String&quot;, # The reason the Certificate was revoked.
225+
},
226+
],
227+
&quot;sequenceNumber&quot;: &quot;A String&quot;, # Output only. The CRL sequence number that appears in pem_crl.
228+
&quot;state&quot;: &quot;A String&quot;, # Output only. The State for this CertificateRevocationList.
229+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time at which this CertificateRevocationList was updated.
230+
},
231+
],
232+
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve next page of results. Pass this value in ListCertificateRevocationListsRequest.next_page_token to retrieve the next page of results.
233+
&quot;unreachable&quot;: [ # A list of locations (e.g. &quot;us-west1&quot;) that could not be reached.
234+
&quot;A String&quot;,
235+
],
236+
}</pre>
237+
</div>
238+
239+
<div class="method">
240+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
241+
<pre>Retrieves the next page of results.
242+
243+
Args:
244+
previous_request: The request for the previous page. (required)
245+
previous_response: The response from the request for the previous page. (required)
246+
247+
Returns:
248+
A request object that you can call &#x27;execute()&#x27; on to request the next
249+
page. Returns None if there are no more items in the collection.
250+
</pre>
251+
</div>
252+
253+
<div class="method">
254+
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
255+
<pre>Update a CertificateRevocationList.
256+
257+
Args:
258+
name: string, Output only. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`. (required)
259+
body: object, The request body.
260+
The object takes the form of:
261+
262+
{ # A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.
263+
&quot;accessUrl&quot;: &quot;A String&quot;, # Output only. The location where &#x27;pem_crl&#x27; can be accessed.
264+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CertificateRevocationList was created.
265+
&quot;labels&quot;: { # Optional. Labels with user-defined metadata.
266+
&quot;a_key&quot;: &quot;A String&quot;,
267+
},
268+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`.
269+
&quot;pemCrl&quot;: &quot;A String&quot;, # Output only. The PEM-encoded X.509 CRL.
270+
&quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of this CertificateRevocationList. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string.
271+
&quot;revokedCertificates&quot;: [ # Output only. The revoked serial numbers that appear in pem_crl.
272+
{ # Describes a revoked Certificate.
273+
&quot;certificate&quot;: &quot;A String&quot;, # The resource name for the Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
274+
&quot;hexSerialNumber&quot;: &quot;A String&quot;, # The serial number of the Certificate.
275+
&quot;revocationReason&quot;: &quot;A String&quot;, # The reason the Certificate was revoked.
276+
},
277+
],
278+
&quot;sequenceNumber&quot;: &quot;A String&quot;, # Output only. The CRL sequence number that appears in pem_crl.
279+
&quot;state&quot;: &quot;A String&quot;, # Output only. The State for this CertificateRevocationList.
280+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time at which this CertificateRevocationList was updated.
281+
}
282+
283+
requestId: string, Optional. An 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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he 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).
284+
updateMask: string, Required. A list of fields to be updated in this request.
285+
x__xgafv: string, V1 error format.
286+
Allowed values
287+
1 - v1 error format
288+
2 - v2 error format
289+
290+
Returns:
291+
An object of the form:
292+
293+
{ # This resource represents a long-running operation that is the result of a network API call.
294+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
295+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
296+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
297+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
298+
{
299+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
300+
},
301+
],
302+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
303+
},
304+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
305+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
306+
},
307+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
308+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
309+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
310+
},
311+
}</pre>
312+
</div>
313+
143314
<div class="method">
144315
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
145316
<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

0 commit comments

Comments
 (0)