Skip to content

Commit

Permalink
feat(apim): update the api
Browse files Browse the repository at this point in the history
#### apim:v1alpha

The following keys were added:
- resources.projects.resources.locations.methods.listApiObservationTags (Total Keys: 16)
- resources.projects.resources.locations.resources.observationJobs.resources.apiObservations.methods.batchEditTags (Total Keys: 12)
- schemas.BatchEditTagsApiObservationsRequest (Total Keys: 4)
- schemas.BatchEditTagsApiObservationsResponse (Total Keys: 4)
- schemas.EditTagsApiObservationsRequest (Total Keys: 5)
- schemas.ListApiObservationTagsResponse (Total Keys: 5)
- schemas.TagAction (Total Keys: 4)
  • Loading branch information
yoshi-automation committed Jul 25, 2024
1 parent 642222f commit f4f6f4c
Show file tree
Hide file tree
Showing 6 changed files with 268 additions and 13 deletions.
44 changes: 44 additions & 0 deletions docs/dyn/apim_v1alpha.projects.locations.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,12 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service.</p>
<p class="toc_element">
<code><a href="#listApiObservationTags">listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListApiObservationTags lists all extant tags on any observation in the given project.</p>
<p class="toc_element">
<code><a href="#listApiObservationTags_next">listApiObservationTags_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
Expand Down Expand Up @@ -169,6 +175,44 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="listApiObservationTags">listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListApiObservationTags lists all extant tags on any observation in the given project.

Args:
parent: string, Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} (required)
pageSize: integer, Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Message for response to listing tags
&quot;apiObservationTags&quot;: [ # The tags from the specified project
&quot;A String&quot;,
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
<code class="details" id="listApiObservationTags_next">listApiObservationTags_next()</code>
<pre>Retrieves the next page of results.

Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)

Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>

<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h2>Instance Methods</h2>
<p class="firstline">GetApiOperation retrieves a single ApiOperation by name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation</p>
<p class="firstline">ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
Expand Down Expand Up @@ -154,7 +154,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation
<pre>ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.

Args:
parent: string, Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (required)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the apiOperations Resource.</p>

<p class="toc_element">
<code><a href="#batchEditTags">batchEditTags(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">BatchEditTagsApiObservations adds or removes Tags for ApiObservations.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand All @@ -87,11 +90,66 @@ <h2>Instance Methods</h2>
<p class="firstline">GetApiObservation retrieves a single ApiObservation by name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListApiObservations gets all ApiObservations for a given project and location and ObservationJob</p>
<p class="firstline">ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchEditTags">batchEditTags(parent, body=None, x__xgafv=None)</code>
<pre>BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

Args:
parent: string, Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
body: object, The request body.
The object takes the form of:

{ # Message for requesting batch edit tags for ApiObservations
&quot;requests&quot;: [ # Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.
{ # Message for requesting edit tags for ApiObservation
&quot;apiObservationId&quot;: &quot;A String&quot;, # Required. Identifier of ApiObservation need to be edit tags Format example: &quot;apigee.googleapis.com|us-west1|443&quot;
&quot;tagActions&quot;: [ # Required. Tag actions to be applied
{ # Message for edit tag action
&quot;action&quot;: &quot;A String&quot;, # Required. Action to be applied
&quot;tag&quot;: &quot;A String&quot;, # Required. Tag to be added or removed
},
],
},
],
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Message for response to edit Tags for ApiObservations
&quot;apiObservations&quot;: [ # ApiObservations that were changed
{ # Message describing ApiObservation object
&quot;apiOperationCount&quot;: &quot;A String&quot;, # The number of observed API Operations.
&quot;createTime&quot;: &quot;A String&quot;, # Create time stamp
&quot;hostname&quot;: &quot;A String&quot;, # The hostname of requests processed for this Observation.
&quot;lastEventDetectedTime&quot;: &quot;A String&quot;, # Last event detected time stamp
&quot;name&quot;: &quot;A String&quot;, # Identifier. Name of resource
&quot;serverIps&quot;: [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `&quot;192.168.1.1&quot;`, `&quot;10.0.0.1:80&quot;`, `&quot;FE80::0202:B3FF:FE1E:8329&quot;`.
&quot;A String&quot;,
],
&quot;sourceLocations&quot;: [ # Location of the Observation Source, for example &quot;us-central1&quot; or &quot;europe-west1.&quot;
&quot;A String&quot;,
],
&quot;style&quot;: &quot;A String&quot;, # Style of ApiObservation
&quot;tags&quot;: [ # User-defined tags to organize and sort
&quot;A String&quot;,
],
&quot;updateTime&quot;: &quot;A String&quot;, # Update time stamp
},
],
}</pre>
</div>

<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
Expand Down Expand Up @@ -133,7 +191,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListApiObservations gets all ApiObservations for a given project and location and ObservationJob
<pre>ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.

Args:
parent: string, Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h2>Instance Methods</h2>
<p class="firstline">GetObservationJob retrieves a single ObservationJob by name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListObservationJobs gets all ObservationJobs for a given project and location</p>
<p class="firstline">ListObservationJobs gets all ObservationJobs for a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
Expand Down Expand Up @@ -303,7 +303,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListObservationJobs gets all ObservationJobs for a given project and location
<pre>ListObservationJobs gets all ObservationJobs for a given project and location.

Args:
parent: string, Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} (required)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h2>Instance Methods</h2>
<p class="firstline">GetObservationSource retrieves a single ObservationSource by name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListObservationSources gets all ObservationSources for a given project and location</p>
<p class="firstline">ListObservationSources gets all ObservationSources for a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
Expand Down Expand Up @@ -220,7 +220,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>ListObservationSources gets all ObservationSources for a given project and location
<pre>ListObservationSources gets all ObservationSources for a given project and location.

Args:
parent: string, Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} (required)
Expand Down
Loading

0 comments on commit f4f6f4c

Please sign in to comment.